Try Spotterno description
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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:
# 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>
state: present # <value in [present, absent]>
fsp_vlan:
_dhcp_status: <value in [disable, enable]>
auth: <value in [radius, usergroup]>
color: <integer>
comments: <string>
dynamic_mapping:
-
_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>
name: <string>
portal_message_override_group: <string>
radius_server: <string>
security: <value in [open, captive-portal, 8021x]>
selected_usergroups: <string>
usergroup: <string>
vdom: <string>
vlanid: <integer>
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:
ac_name: <string>
aggregate: <string>
algorithm: <value in [L2, L3, L4, ...]>
alias: <string>
allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
- dnp
- ftm
- fabric
- speed-test
ap_discover: <value in [disable, enable]>
arpforward: <value in [disable, enable]>
atm_protocol: <value in [none, ipoa]>
auth_type: <value in [auto, pap, chap, ...]>
auto_auth_extension_device: <value in [disable, enable]>
bandwidth_measure_time: <integer>
bfd: <value in [global, enable, disable]>
bfd_desired_min_tx: <integer>
bfd_detect_mult: <integer>
bfd_required_min_rx: <integer>
broadcast_forticlient_discovery: <value in [disable, enable]>
broadcast_forward: <value in [disable, enable]>
captive_portal: <integer>
cli_conn_status: <integer>
color: <integer>
ddns: <value in [disable, enable]>
ddns_auth: <value in [disable, tsig]>
ddns_domain: <string>
ddns_key: <list or string>
ddns_keyname: <string>
ddns_password: <list or string>
ddns_server: <value in [dhs.org, dyndns.org, dyns.net, ...]>
ddns_server_ip: <string>
ddns_sn: <string>
ddns_ttl: <integer>
ddns_username: <string>
ddns_zone: <string>
dedicated_to: <value in [none, management]>
defaultgw: <value in [disable, enable]>
description: <string>
detected_peer_mtu: <integer>
detectprotocol:
- ping
- tcp-echo
- udp-echo
detectserver: <string>
device_access_list: <list or string>
device_identification: <value in [disable, enable]>
device_identification_active_scan: <value in [disable, enable]>
device_netscan: <value in [disable, enable]>
device_user_identification: <value in [disable, enable]>
devindex: <integer>
dhcp_client_identifier: <string>
dhcp_relay_agent_option: <value in [disable, enable]>
dhcp_relay_interface: <string>
dhcp_relay_interface_select_method: <value in [auto, sdwan, specify]>
dhcp_relay_ip: <list or string>
dhcp_relay_service: <value in [disable, enable]>
dhcp_relay_type: <value in [regular, ipsec]>
dhcp_renew_time: <integer>
disc_retry_timeout: <integer>
disconnect_threshold: <integer>
distance: <integer>
dns_query: <value in [disable, recursive, non-recursive]>
dns_server_override: <value in [disable, enable]>
drop_fragment: <value in [disable, enable]>
drop_overlapped_fragment: <value in [disable, enable]>
egress_cos: <value in [disable, cos0, cos1, ...]>
egress_shaping_profile: <string>
eip: <string>
endpoint_compliance: <value in [disable, enable]>
estimated_downstream_bandwidth: <integer>
estimated_upstream_bandwidth: <integer>
explicit_ftp_proxy: <value in [disable, enable]>
explicit_web_proxy: <value in [disable, enable]>
external: <value in [disable, enable]>
fail_action_on_extender: <value in [soft-restart, hard-restart, reboot]>
fail_alert_interfaces: <list or string>
fail_alert_method: <value in [link-failed-signal, link-down]>
fail_detect: <value in [disable, enable]>
fail_detect_option:
- detectserver
- link-down
fdp: <value in [disable, enable]>
fortiheartbeat: <value in [disable, enable]>
fortilink: <value in [disable, enable]>
fortilink_backup_link: <integer>
fortilink_neighbor_detect: <value in [lldp, fortilink]>
fortilink_split_interface: <value in [disable, enable]>
fortilink_stacking: <value in [disable, enable]>
forward_domain: <integer>
forward_error_correction: <value in [disable, enable, rs-fec, ...]>
fp_anomaly:
- drop_tcp_fin_noack
- pass_winnuke
- pass_tcpland
- pass_udpland
- pass_icmpland
- pass_ipland
- pass_iprr
- pass_ipssrr
- pass_iplsrr
- pass_ipstream
- pass_ipsecurity
- pass_iptimestamp
- pass_ipunknown_option
- pass_ipunknown_prot
- pass_icmp_frag
- pass_tcp_no_flag
- pass_tcp_fin_noack
- drop_winnuke
- drop_tcpland
- drop_udpland
- drop_icmpland
- drop_ipland
- drop_iprr
- drop_ipssrr
- drop_iplsrr
- drop_ipstream
- drop_ipsecurity
- drop_iptimestamp
- drop_ipunknown_option
- drop_ipunknown_prot
- drop_icmp_frag
- drop_tcp_no_flag
fp_disable:
- all
- ipsec
- none
gateway_address: <string>
gi_gk: <value in [disable, enable]>
gwaddr: <string>
gwdetect: <value in [disable, enable]>
ha_priority: <integer>
icmp_accept_redirect: <value in [disable, enable]>
icmp_redirect: <value in [disable, enable]>
icmp_send_redirect: <value in [disable, enable]>
ident_accept: <value in [disable, enable]>
idle_timeout: <integer>
if_mdix: <value in [auto, normal, crossover]>
if_media: <value in [auto, copper, fiber]>
in_force_vlan_cos: <integer>
inbandwidth: <integer>
ingress_cos: <value in [disable, cos0, cos1, ...]>
ingress_shaping_profile: <string>
ingress_spillover_threshold: <integer>
internal: <integer>
ip: <string>
ip_managed_by_fortiipam: <value in [disable, enable, inherit-global]>
ipmac: <value in [disable, enable]>
ips_sniffer_mode: <value in [disable, enable]>
ipunnumbered: <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>
l2forward: <value in [disable, enable]>
l2tp_client: <value in [disable, enable]>
lacp_ha_slave: <value in [disable, enable]>
lacp_mode: <value in [static, passive, active]>
lacp_speed: <value in [slow, fast]>
lcp_echo_interval: <integer>
lcp_max_echo_fails: <integer>
link_up_delay: <integer>
listen_forticlient_connection: <value in [disable, enable]>
lldp_network_policy: <string>
lldp_reception: <value in [disable, enable, vdom]>
lldp_transmission: <value in [enable, disable, vdom]>
log: <value in [disable, enable]>
macaddr: <string>
managed_subnetwork_size: <value in [256, 512, 1024, ...]>
management_ip: <string>
max_egress_burst_rate: <integer>
max_egress_rate: <integer>
measured_downstream_bandwidth: <integer>
measured_upstream_bandwidth: <integer>
mediatype: <value in [serdes-sfp, sgmii-sfp, cfp2-sr10, ...]>
member: <list or string>
min_links: <integer>
min_links_down: <value in [operational, administrative]>
mode: <value in [static, dhcp, pppoe, ...]>
monitor_bandwidth: <value in [disable, enable]>
mtu: <integer>
mtu_override: <value in [disable, enable]>
mux_type: <value in [llc-encaps, vc-encaps]>
name: <string>
ndiscforward: <value in [disable, enable]>
netbios_forward: <value in [disable, enable]>
netflow_sampler: <value in [disable, tx, rx, ...]>
np_qos_profile: <integer>
npu_fastpath: <value in [disable, enable]>
nst: <value in [disable, enable]>
out_force_vlan_cos: <integer>
outbandwidth: <integer>
padt_retry_timeout: <integer>
password: <list or string>
peer_interface: <list or string>
phy_mode: <value in [auto, adsl, vdsl, ...]>
ping_serv_status: <integer>
poe: <value in [disable, enable]>
polling_interval: <integer>
pppoe_unnumbered_negotiate: <value in [disable, enable]>
pptp_auth_type: <value in [auto, pap, chap, ...]>
pptp_client: <value in [disable, enable]>
pptp_password: <list or string>
pptp_server_ip: <string>
pptp_timeout: <integer>
pptp_user: <string>
preserve_session_route: <value in [disable, enable]>
priority: <integer>
priority_override: <value in [disable, enable]>
proxy_captive_portal: <value in [disable, enable]>
redundant_interface: <string>
remote_ip: <string>
replacemsg_override_group: <string>
retransmission: <value in [disable, enable]>
ring_rx: <integer>
ring_tx: <integer>
role: <value in [lan, wan, dmz, ...]>
sample_direction: <value in [rx, tx, both]>
sample_rate: <integer>
scan_botnet_connections: <value in [disable, block, monitor]>
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>
security_8021x_dynamic_vlan_id: <integer>
security_8021x_master: <string>
security_8021x_mode: <value in [default, dynamic-vlan, fallback, ...]>
security_exempt_list: <string>
security_external_logout: <string>
security_external_web: <string>
security_groups: <list or string>
security_mac_auth_bypass: <value in [disable, enable, mac-auth-only]>
security_mode: <value in [none, captive-portal, 802.1X]>
security_redirect_url: <string>
service_name: <string>
sflow_sampler: <value in [disable, enable]>
speed: <value in [auto, 10full, 10half, ...]>
spillover_threshold: <integer>
src_check: <value in [disable, enable]>
status: <value in [down, up]>
stp: <value in [disable, enable]>
stp_ha_slave: <value in [disable, enable, priority-adjust]>
stpforward: <value in [disable, enable]>
stpforward_mode: <value in [rpl-all-ext-id, rpl-bridge-ext-id, rpl-nothing]>
strip_priority_vlan_tag: <value in [disable, enable]>
subst: <value in [disable, enable]>
substitute_dst_mac: <string>
swc_first_create: <integer>
swc_vlan: <integer>
switch: <string>
switch_controller_access_vlan: <value in [disable, enable]>
switch_controller_arp_inspection: <value in [disable, enable]>
switch_controller_auth: <value in [radius, usergroup]>
switch_controller_dhcp_snooping: <value in [disable, enable]>
switch_controller_dhcp_snooping_option82: <value in [disable, enable]>
switch_controller_dhcp_snooping_verify_mac: <value in [disable, enable]>
switch_controller_feature: <value in [none, default-vlan, quarantine, ...]>
switch_controller_igmp_snooping: <value in [disable, enable]>
switch_controller_igmp_snooping_fast_leave: <value in [disable, enable]>
switch_controller_igmp_snooping_proxy: <value in [disable, enable]>
switch_controller_iot_scanning: <value in [disable, enable]>
switch_controller_learning_limit: <integer>
switch_controller_mgmt_vlan: <integer>
switch_controller_nac: <string>
switch_controller_radius_server: <string>
switch_controller_rspan_mode: <value in [disable, enable]>
switch_controller_source_ip: <value in [outbound, fixed]>
switch_controller_traffic_policy: <string>
tc_mode: <value in [ptm, atm]>
tcp_mss: <integer>
trunk: <value in [disable, enable]>
trust_ip_1: <string>
trust_ip_2: <string>
trust_ip_3: <string>
trust_ip6_1: <string>
trust_ip6_2: <string>
trust_ip6_3: <string>
type: <value in [physical, vlan, aggregate, ...]>
username: <string>
vci: <integer>
vectoring: <value in [disable, enable]>
vindex: <integer>
vlan_protocol: <value in [8021q, 8021ad]>
vlanforward: <value in [disable, enable]>
vlanid: <integer>
vpi: <integer>
vrf: <integer>
vrrp:
-
accept_mode: <value in [disable, enable]>
adv_interval: <integer>
ignore_default_route: <value in [disable, enable]>
preempt: <value in [disable, enable]>
priority: <integer>
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>
proxy_arp:
-
id: <integer>
ip: <string>
vrrp_virtual_mac: <value in [disable, enable]>
wccp: <value in [disable, enable]>
weight: <integer>
wifi_5g_threshold: <string>
wifi_acl: <value in [deny, allow]>
wifi_ap_band: <value in [any, 5g-preferred, 5g-only]>
wifi_auth: <value in [PSK, RADIUS, radius, ...]>
wifi_auto_connect: <value in [disable, enable]>
wifi_auto_save: <value in [disable, enable]>
wifi_broadcast_ssid: <value in [disable, enable]>
wifi_encrypt: <value in [TKIP, AES]>
wifi_fragment_threshold: <integer>
wifi_key: <list or string>
wifi_keyindex: <integer>
wifi_mac_filter: <value in [disable, enable]>
wifi_passphrase: <list or string>
wifi_radius_server: <string>
wifi_rts_threshold: <integer>
wifi_security: <value in [None, WEP64, wep64, ...]>
wifi_ssid: <string>
wifi_usergroup: <string>
wins_ip: <string>
dhcp_relay_request_all_server: <value in [disable, enable]>
stp_ha_secondary: <value in [disable, enable, priority-adjust]>
switch_controller_dynamic: <string>
auth_cert: <string>
auth_portal_addr: <string>
dhcp_classless_route_addition: <value in [disable, enable]>
dhcp_relay_link_selection: <string>
dns_server_protocol:
- cleartext
- dot
- doh
eap_ca_cert: <string>
eap_identity: <string>
eap_method: <value in [tls, peap]>
eap_password: <list or string>
eap_supplicant: <value in [disable, enable]>
eap_user_cert: <string>
ike_saml_server: <string>
lacp_ha_secondary: <value in [disable, enable]>
pvc_atm_qos: <value in [cbr, rt-vbr, nrt-vbr]>
pvc_chan: <integer>
pvc_crc: <integer>
pvc_pcr: <integer>
pvc_scr: <integer>
pvc_vlan_id: <integer>
pvc_vlan_rx_id: <integer>
pvc_vlan_rx_op: <value in [pass-through, replace, remove]>
pvc_vlan_tx_id: <integer>
pvc_vlan_tx_op: <value in [pass-through, replace, remove]>
reachable_time: <integer>
select_profile_30a_35b: <value in [30A, 35B]>
sfp_dsl: <value in [disable, enable]>
sfp_dsl_adsl_fallback: <value in [disable, enable]>
sfp_dsl_autodetect: <value in [disable, enable]>
sfp_dsl_mac: <string>
sw_algorithm: <value in [l2, l3, eh]>
system_id: <string>
system_id_type: <value in [auto, user]>
vlan_id: <integer>
vlan_op_mode: <value in [tag, untag, passthrough]>
generic_receive_offload: <value in [disable, enable]>
interconnect_profile: <value in [default, profile1, profile2]>
large_receive_offload: <value in [disable, enable]>
annex: <value in [a, b, j, ...]>
aggregate_type: <value in [physical, vxlan]>
switch_controller_netflow_collect: <value in [disable, enable]>
wifi_dns_server1: <string>
wifi_dns_server2: <string>
wifi_gateway: <string>
default_purdue_level: <value in [1, 2, 3, ...]>
dhcp_broadcast_flag: <value in [disable, enable]>
dhcp_smart_relay: <value in [disable, enable]>
switch_controller_offloading: <value in [disable, enable]>
switch_controller_offloading_gw: <value in [disable, enable]>
switch_controller_offloading_ip: <string>
dhcp_relay_circuit_id: <string>
dhcp_relay_source_ip: <string>
switch_controller_offload: <value in [disable, enable]>
switch_controller_offload_gw: <value in [disable, enable]>
switch_controller_offload_ip: <string>
mirroring_direction: <value in [rx, tx, both]>
mirroring_port: <string>
port_mirroring: <value in [disable, enable]>
security_8021x_member_mode: <value in [disable, switch]>
stp_edge: <value in [disable, enable]>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
fsp_vlan:
description: The top level parameters set.
required: false
suboptions:
_dhcp-status:
choices:
- disable
- enable
description: Deprecated, please rename it to _dhcp_status. _Dhcp-Status.
type: str
auth:
choices:
- radius
- usergroup
description: No description.
type: str
color:
description: Color.
type: int
comments:
description: No description.
type: str
dhcp-server:
description: Deprecated, please rename it to dhcp_server.
suboptions:
auto-configuration:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_configuration. Enable/disable
auto configuration.
type: str
auto-managed-status:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_managed_status. Enable/disable
use of this DHCP server once this interface ha...
type: str
conflicted-ip-timeout:
description: Deprecated, please rename it to conflicted_ip_timeout. Time in
seconds to wait after a conflicted IP address is re...
type: int
ddns-auth:
choices:
- disable
- tsig
description: Deprecated, please rename it to ddns_auth. DDNS authentication
mode.
type: str
ddns-key:
description: (list or str) Deprecated, please rename it to ddns_key. DDNS
update key
type: raw
ddns-keyname:
description: Deprecated, please rename it to ddns_keyname. DDNS update key
name.
type: str
ddns-server-ip:
description: Deprecated, please rename it to ddns_server_ip. DDNS server IP.
type: str
ddns-ttl:
description: Deprecated, please rename it to ddns_ttl. TTL.
type: int
ddns-update:
choices:
- disable
- enable
description: Deprecated, please rename it to ddns_update. Enable/disable DDNS
update for DHCP.
type: str
ddns-update-override:
choices:
- disable
- enable
description: Deprecated, please rename it to ddns_update_override. Enable/disable
DDNS update override for DHCP.
type: str
ddns-zone:
description: Deprecated, please rename it to ddns_zone. Zone of your domain
name
type: str
default-gateway:
description: Deprecated, please rename it to default_gateway. Default gateway
IP address assigned by the DHCP server.
type: str
dhcp-settings-from-fortiipam:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_settings_from_fortiipam.
Enable/disable populating of DHCP server settings fr...
type: str
dns-server1:
description: Deprecated, please rename it to dns_server1. DNS server 1.
type: str
dns-server2:
description: Deprecated, please rename it to dns_server2. DNS server 2.
type: str
dns-server3:
description: Deprecated, please rename it to dns_server3. DNS server 3.
type: str
dns-server4:
description: Deprecated, please rename it to dns_server4. DNS server 4.
type: str
dns-service:
choices:
- default
- specify
- local
description: Deprecated, please rename it to dns_service. Options for assigning
DNS servers to DHCP clients.
type: str
domain:
description: Domain name suffix for the IP addresses that the DHCP server
assigns to clients.
type: str
enable:
choices:
- disable
- enable
description: Enable.
type: str
exclude-range:
description: Deprecated, please rename it to exclude_range. Exclude-Range.
elements: dict
suboptions:
end-ip:
description: Deprecated, please rename it to end_ip. End of IP range.
type: str
id:
description: ID.
type: int
lease-time:
description: Deprecated, please rename it to lease_time. Lease time in
seconds, 0 means default lease time.
type: int
start-ip:
description: Deprecated, please rename it to start_ip. Start of IP range.
type: str
uci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to uci_match. Enable/disable
user class identifier
type: str
uci-string:
description: (list) Deprecated, please rename it to uci_string.
type: raw
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable
vendor class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string.
type: raw
type: list
filename:
description: Name of the boot file on the TFTP server.
type: str
forticlient-on-net-status:
choices:
- disable
- enable
description: Deprecated, please rename it to forticlient_on_net_status. Enable/disable
FortiClient-On-Net service for this DHCP...
type: str
id:
description: ID.
type: int
ip-mode:
choices:
- range
- usrgrp
description: Deprecated, please rename it to ip_mode. Method used to assign
client IP.
type: str
ip-range:
description: Deprecated, please rename it to ip_range. Ip-Range.
elements: dict
suboptions:
end-ip:
description: Deprecated, please rename it to end_ip. End of IP range.
type: str
id:
description: ID.
type: int
lease-time:
description: Deprecated, please rename it to lease_time. Lease time in
seconds, 0 means default lease time.
type: int
start-ip:
description: Deprecated, please rename it to start_ip. Start of IP range.
type: str
uci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to uci_match. Enable/disable
user class identifier
type: str
uci-string:
description: (list) Deprecated, please rename it to uci_string.
type: raw
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable
vendor class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string.
type: raw
type: list
ipsec-lease-hold:
description: Deprecated, please rename it to ipsec_lease_hold. DHCP over IPsec
leases expire this many seconds after tunnel down
type: int
lease-time:
description: Deprecated, please rename it to lease_time. Lease time in seconds,
0 means unlimited.
type: int
mac-acl-default-action:
choices:
- assign
- block
description: Deprecated, please rename it to mac_acl_default_action. MAC access
control default action
type: str
netmask:
description: Netmask assigned by the DHCP server.
type: str
next-server:
description: Deprecated, please rename it to next_server. IP address of a
server
type: str
ntp-server1:
description: Deprecated, please rename it to ntp_server1. NTP server 1.
type: str
ntp-server2:
description: Deprecated, please rename it to ntp_server2. NTP server 2.
type: str
ntp-server3:
description: Deprecated, please rename it to ntp_server3. NTP server 3.
type: str
ntp-service:
choices:
- default
- specify
- local
description: Deprecated, please rename it to ntp_service. Options for assigning
Network Time Protocol
type: str
option1:
description: (list) Option1.
type: raw
option2:
description: (list) Option2.
type: raw
option3:
description: (list) Option3.
type: raw
option4:
description: Option4.
type: str
option5:
description: Option5.
type: str
option6:
description: Option6.
type: str
options:
description: Options.
elements: dict
suboptions:
code:
description: DHCP option code.
type: int
id:
description: ID.
type: int
ip:
description: (list) DHCP option IPs.
type: raw
type:
choices:
- hex
- string
- ip
- fqdn
description: DHCP option type.
type: str
uci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to uci_match. Enable/disable
user class identifier
type: str
uci-string:
description: (list) Deprecated, please rename it to uci_string.
type: raw
value:
description: DHCP option value.
type: str
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable
vendor class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string.
type: raw
type: list
relay-agent:
description: Deprecated, please rename it to relay_agent. Relay agent IP.
type: str
reserved-address:
description: Deprecated, please rename it to reserved_address. Reserved-Address.
elements: dict
suboptions:
action:
choices:
- assign
- block
- reserved
description: Options for the DHCP server to configure the client with
the reserved MAC address.
type: str
circuit-id:
description: Deprecated, please rename it to circuit_id. Option 82 circuit-ID
of the client that will get the reserved ...
type: str
circuit-id-type:
choices:
- hex
- string
description: Deprecated, please rename it to circuit_id_type. DHCP option
type.
type: str
description:
description: Description.
type: str
id:
description: ID.
type: int
ip:
description: IP address to be reserved for the MAC address.
type: str
mac:
description: MAC address of the client that will get the reserved IP address.
type: str
remote-id:
description: Deprecated, please rename it to remote_id. Option 82 remote-ID
of the client that will get the reserved IP...
type: str
remote-id-type:
choices:
- hex
- string
description: Deprecated, please rename it to remote_id_type. DHCP option
type.
type: str
type:
choices:
- mac
- option82
description: DHCP reserved-address type.
type: str
type: list
server-type:
choices:
- regular
- ipsec
description: Deprecated, please rename it to server_type. DHCP server can
be a normal DHCP server or an IPsec DHCP server.
type: str
shared-subnet:
choices:
- disable
- enable
description: Deprecated, please rename it to shared_subnet. Enable/disable
shared subnet.
type: str
status:
choices:
- disable
- enable
description: Enable/disable this DHCP configuration.
type: str
tftp-server:
description: (list) Deprecated, please rename it to tftp_server. One or more
hostnames or IP addresses of the TFTP servers in q...
type: raw
timezone:
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'
description: Select the time zone to be assigned to DHCP clients.
type: str
timezone-option:
choices:
- disable
- default
- specify
description: Deprecated, please rename it to timezone_option. Options for
the DHCP server to set the clients time zone.
type: str
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable vendor
class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string. One or more
VCI strings in quotes separated by spaces.
type: raw
wifi-ac-service:
choices:
- specify
- local
description: Deprecated, please rename it to wifi_ac_service. Options for
assigning WiFi Access Controllers to DHCP clients
type: str
wifi-ac1:
description: Deprecated, please rename it to wifi_ac1. WiFi Access Controller
1 IP address
type: str
wifi-ac2:
description: Deprecated, please rename it to wifi_ac2. WiFi Access Controller
2 IP address
type: str
wifi-ac3:
description: Deprecated, please rename it to wifi_ac3. WiFi Access Controller
3 IP address
type: str
wins-server1:
description: Deprecated, please rename it to wins_server1. WINS server 1.
type: str
wins-server2:
description: Deprecated, please rename it to wins_server2. WINS server 2.
type: str
type: dict
dynamic_mapping:
description: Dynamic_Mapping.
elements: dict
suboptions:
_dhcp-status:
choices:
- disable
- enable
description: Deprecated, please rename it to _dhcp_status. _Dhcp-Status.
type: str
_scope:
description: _Scope.
elements: dict
suboptions:
name:
description: Name.
type: str
vdom:
description: Vdom.
type: str
type: list
dhcp-server:
description: Deprecated, please rename it to dhcp_server.
suboptions:
auto-configuration:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_configuration. Enable/disable
auto configuration.
type: str
auto-managed-status:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_managed_status. Enable/disable
use of this DHCP server once this inte...
type: str
conflicted-ip-timeout:
description: Deprecated, please rename it to conflicted_ip_timeout. Time
in seconds to wait after a conflicted IP addre...
type: int
ddns-auth:
choices:
- disable
- tsig
description: Deprecated, please rename it to ddns_auth. DDNS authentication
mode.
type: str
ddns-key:
description: (list or str) Deprecated, please rename it to ddns_key. DDNS
update key
type: raw
ddns-keyname:
description: Deprecated, please rename it to ddns_keyname. DDNS update
key name.
type: str
ddns-server-ip:
description: Deprecated, please rename it to ddns_server_ip. DDNS server
IP.
type: str
ddns-ttl:
description: Deprecated, please rename it to ddns_ttl. TTL.
type: int
ddns-update:
choices:
- disable
- enable
description: Deprecated, please rename it to ddns_update. Enable/disable
DDNS update for DHCP.
type: str
ddns-update-override:
choices:
- disable
- enable
description: Deprecated, please rename it to ddns_update_override. Enable/disable
DDNS update override for DHCP.
type: str
ddns-zone:
description: Deprecated, please rename it to ddns_zone. Zone of your domain
name
type: str
default-gateway:
description: Deprecated, please rename it to default_gateway. Default
gateway IP address assigned by the DHCP server.
type: str
dhcp-settings-from-fortiipam:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_settings_from_fortiipam.
Enable/disable populating of DHCP server set...
type: str
dns-server1:
description: Deprecated, please rename it to dns_server1. DNS server 1.
type: str
dns-server2:
description: Deprecated, please rename it to dns_server2. DNS server 2.
type: str
dns-server3:
description: Deprecated, please rename it to dns_server3. DNS server 3.
type: str
dns-server4:
description: Deprecated, please rename it to dns_server4. DNS server 4.
type: str
dns-service:
choices:
- default
- specify
- local
description: Deprecated, please rename it to dns_service. Options for
assigning DNS servers to DHCP clients.
type: str
domain:
description: Domain name suffix for the IP addresses that the DHCP server
assigns to clients.
type: str
enable:
choices:
- disable
- enable
description: Enable.
type: str
exclude-range:
description: Deprecated, please rename it to exclude_range. Exclude-Range.
elements: dict
suboptions:
end-ip:
description: Deprecated, please rename it to end_ip. End of IP range.
type: str
id:
description: ID.
type: int
lease-time:
description: Deprecated, please rename it to lease_time. Lease time
in seconds, 0 means default lease time.
type: int
start-ip:
description: Deprecated, please rename it to start_ip. Start of IP
range.
type: str
uci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to uci_match. Enable/disable
user class identifier
type: str
uci-string:
description: (list) Deprecated, please rename it to uci_string.
type: raw
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable
vendor class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string.
type: raw
type: list
filename:
description: Name of the boot file on the TFTP server.
type: str
forticlient-on-net-status:
choices:
- disable
- enable
description: Deprecated, please rename it to forticlient_on_net_status.
Enable/disable FortiClient-On-Net service for t...
type: str
id:
description: ID.
type: int
ip-mode:
choices:
- range
- usrgrp
description: Deprecated, please rename it to ip_mode. Method used to assign
client IP.
type: str
ip-range:
description: Deprecated, please rename it to ip_range. Ip-Range.
elements: dict
suboptions:
end-ip:
description: Deprecated, please rename it to end_ip. End of IP range.
type: str
id:
description: ID.
type: int
lease-time:
description: Deprecated, please rename it to lease_time. Lease time
in seconds, 0 means default lease time.
type: int
start-ip:
description: Deprecated, please rename it to start_ip. Start of IP
range.
type: str
uci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to uci_match. Enable/disable
user class identifier
type: str
uci-string:
description: (list) Deprecated, please rename it to uci_string.
type: raw
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable
vendor class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string.
type: raw
type: list
ipsec-lease-hold:
description: Deprecated, please rename it to ipsec_lease_hold. DHCP over
IPsec leases expire this many seconds after tu...
type: int
lease-time:
description: Deprecated, please rename it to lease_time. Lease time in
seconds, 0 means unlimited.
type: int
mac-acl-default-action:
choices:
- assign
- block
description: Deprecated, please rename it to mac_acl_default_action. MAC
access control default action
type: str
netmask:
description: Netmask assigned by the DHCP server.
type: str
next-server:
description: Deprecated, please rename it to next_server. IP address of
a server
type: str
ntp-server1:
description: Deprecated, please rename it to ntp_server1. NTP server 1.
type: str
ntp-server2:
description: Deprecated, please rename it to ntp_server2. NTP server 2.
type: str
ntp-server3:
description: Deprecated, please rename it to ntp_server3. NTP server 3.
type: str
ntp-service:
choices:
- default
- specify
- local
description: Deprecated, please rename it to ntp_service. Options for
assigning Network Time Protocol
type: str
option1:
description: (list) Option1.
type: raw
option2:
description: (list) Option2.
type: raw
option3:
description: (list) Option3.
type: raw
option4:
description: Option4.
type: str
option5:
description: Option5.
type: str
option6:
description: Option6.
type: str
options:
description: Options.
elements: dict
suboptions:
code:
description: DHCP option code.
type: int
id:
description: ID.
type: int
ip:
description: (list) DHCP option IPs.
type: raw
type:
choices:
- hex
- string
- ip
- fqdn
description: DHCP option type.
type: str
uci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to uci_match. Enable/disable
user class identifier
type: str
uci-string:
description: (list) Deprecated, please rename it to uci_string.
type: raw
value:
description: DHCP option value.
type: str
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable
vendor class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string.
type: raw
type: list
relay-agent:
description: Deprecated, please rename it to relay_agent. Relay agent
IP.
type: str
reserved-address:
description: Deprecated, please rename it to reserved_address. Reserved-Address.
elements: dict
suboptions:
action:
choices:
- assign
- block
- reserved
description: Options for the DHCP server to configure the client with
the reserved MAC address.
type: str
circuit-id:
description: Deprecated, please rename it to circuit_id. Option 82
circuit-ID of the client that will get the r...
type: str
circuit-id-type:
choices:
- hex
- string
description: Deprecated, please rename it to circuit_id_type. DHCP
option type.
type: str
description:
description: Description.
type: str
id:
description: ID.
type: int
ip:
description: IP address to be reserved for the MAC address.
type: str
mac:
description: MAC address of the client that will get the reserved
IP address.
type: str
remote-id:
description: Deprecated, please rename it to remote_id. Option 82
remote-ID of the client that will get the res...
type: str
remote-id-type:
choices:
- hex
- string
description: Deprecated, please rename it to remote_id_type. DHCP
option type.
type: str
type:
choices:
- mac
- option82
description: DHCP reserved-address type.
type: str
type: list
server-type:
choices:
- regular
- ipsec
description: Deprecated, please rename it to server_type. DHCP server
can be a normal DHCP server or an IPsec DHCP server.
type: str
shared-subnet:
choices:
- disable
- enable
description: Deprecated, please rename it to shared_subnet. Enable/disable
shared subnet.
type: str
status:
choices:
- disable
- enable
description: Enable/disable this DHCP configuration.
type: str
tftp-server:
description: (list) Deprecated, please rename it to tftp_server. One or
more hostnames or IP addresses of the TFTP serv...
type: raw
timezone:
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'
description: Select the time zone to be assigned to DHCP clients.
type: str
timezone-option:
choices:
- disable
- default
- specify
description: Deprecated, please rename it to timezone_option. Options
for the DHCP server to set the clients time zone.
type: str
vci-match:
choices:
- disable
- enable
description: Deprecated, please rename it to vci_match. Enable/disable
vendor class identifier
type: str
vci-string:
description: (list) Deprecated, please rename it to vci_string. One or
more VCI strings in quotes separated by spaces.
type: raw
wifi-ac-service:
choices:
- specify
- local
description: Deprecated, please rename it to wifi_ac_service. Options
for assigning WiFi Access Controllers to DHCP clients
type: str
wifi-ac1:
description: Deprecated, please rename it to wifi_ac1. WiFi Access Controller
1 IP address
type: str
wifi-ac2:
description: Deprecated, please rename it to wifi_ac2. WiFi Access Controller
2 IP address
type: str
wifi-ac3:
description: Deprecated, please rename it to wifi_ac3. WiFi Access Controller
3 IP address
type: str
wins-server1:
description: Deprecated, please rename it to wins_server1. WINS server
1.
type: str
wins-server2:
description: Deprecated, please rename it to wins_server2. WINS server
2.
type: str
type: dict
interface:
description: No description.
suboptions:
dhcp-relay-agent-option:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_relay_agent_option.
Dhcp-Relay-Agent-Option.
type: str
dhcp-relay-interface-select-method:
choices:
- auto
- sdwan
- specify
description: Deprecated, please rename it to dhcp_relay_interface_select_method.
type: str
dhcp-relay-ip:
description: (list) Deprecated, please rename it to dhcp_relay_ip. Dhcp-Relay-Ip.
type: raw
dhcp-relay-service:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_relay_service. Dhcp-Relay-Service.
type: str
dhcp-relay-type:
choices:
- regular
- ipsec
description: Deprecated, please rename it to dhcp_relay_type. Dhcp-Relay-Type.
type: str
ip:
description: Ip.
type: str
ipv6:
description: No description.
suboptions:
autoconf:
choices:
- disable
- enable
description: Enable/disable address auto config.
type: str
cli-conn6-status:
description: Deprecated, please rename it to cli_conn6_status. Cli-Conn6-Status.
type: int
dhcp6-client-options:
choices:
- rapid
- iapd
- iana
- dns
- dnsname
description: Deprecated, please rename it to dhcp6_client_options.
Dhcp6-Client-Options.
elements: str
type: list
dhcp6-information-request:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_information_request.
Enable/disable DHCPv6 information request.
type: str
dhcp6-prefix-delegation:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_prefix_delegation.
Enable/disable DHCPv6 prefix delegation.
type: str
dhcp6-prefix-hint:
description: Deprecated, please rename it to dhcp6_prefix_hint. DHCPv6
prefix that will be used as a hint to th...
type: str
dhcp6-prefix-hint-plt:
description: Deprecated, please rename it to dhcp6_prefix_hint_plt.
DHCPv6 prefix hint preferred life time
type: int
dhcp6-prefix-hint-vlt:
description: Deprecated, please rename it to dhcp6_prefix_hint_vlt.
DHCPv6 prefix hint valid life time
type: int
dhcp6-relay-interface-id:
description: Deprecated, please rename it to dhcp6_relay_interface_id.
DHCP6 relay interface ID.
type: str
dhcp6-relay-ip:
description: Deprecated, please rename it to dhcp6_relay_ip. DHCPv6
relay IP address.
type: str
dhcp6-relay-service:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_relay_service.
Enable/disable DHCPv6 relay.
type: str
dhcp6-relay-source-interface:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_relay_source_interface.
Enable/disable use of address on thi...
type: str
dhcp6-relay-source-ip:
description: Deprecated, please rename it to dhcp6_relay_source_ip.
IPv6 address used by the DHCP6 relay as its...
type: str
dhcp6-relay-type:
choices:
- regular
description: Deprecated, please rename it to dhcp6_relay_type. DHCPv6
relay type.
type: str
icmp6-send-redirect:
choices:
- disable
- enable
description: Deprecated, please rename it to icmp6_send_redirect.
Enable/disable sending of ICMPv6 redirects.
type: str
interface-identifier:
description: Deprecated, please rename it to interface_identifier.
IPv6 interface identifier.
type: str
ip6-address:
description: Deprecated, please rename it to ip6_address. Primary
IPv6 address prefix, syntax
type: str
ip6-allowaccess:
choices:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
description: Deprecated, please rename it to ip6_allowaccess. Allow
management access to the interface.
elements: str
type: list
ip6-default-life:
description: Deprecated, please rename it to ip6_default_life. Default
life
type: int
ip6-delegated-prefix-iaid:
description: Deprecated, please rename it to ip6_delegated_prefix_iaid.
IAID of obtained delegated-prefix from ...
type: int
ip6-delegated-prefix-list:
description: Deprecated, please rename it to ip6_delegated_prefix_list.
Ip6-Delegated-Prefix-List.
elements: dict
suboptions:
autonomous-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to autonomous_flag.
Enable/disable the autonomous flag.
type: str
delegated-prefix-iaid:
description: Deprecated, please rename it to delegated_prefix_iaid.
IAID of obtained delegated-prefix f...
type: int
onlink-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to onlink_flag. Enable/disable
the onlink flag.
type: str
prefix-id:
description: Deprecated, please rename it to prefix_id. Prefix
ID.
type: int
rdnss:
description: (list) Recursive DNS server option.
type: raw
rdnss-service:
choices:
- delegated
- default
- specify
description: Deprecated, please rename it to rdnss_service. Recursive
DNS service option.
type: str
subnet:
description: Add subnet ID to routing prefix.
type: str
upstream-interface:
description: Deprecated, please rename it to upstream_interface.
Name of the interface that provides de...
type: str
type: list
ip6-dns-server-override:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_dns_server_override.
Enable/disable using the DNS server acqui...
type: str
ip6-extra-addr:
description: Deprecated, please rename it to ip6_extra_addr. Ip6-Extra-Addr.
elements: dict
suboptions:
prefix:
description: IPv6 address prefix.
type: str
type: list
ip6-hop-limit:
description: Deprecated, please rename it to ip6_hop_limit. Hop limit
type: int
ip6-link-mtu:
description: Deprecated, please rename it to ip6_link_mtu. IPv6 link
MTU.
type: int
ip6-manage-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_manage_flag. Enable/disable
the managed flag.
type: str
ip6-max-interval:
description: Deprecated, please rename it to ip6_max_interval. IPv6
maximum interval
type: int
ip6-min-interval:
description: Deprecated, please rename it to ip6_min_interval. IPv6
minimum interval
type: int
ip6-mode:
choices:
- static
- dhcp
- pppoe
- delegated
description: Deprecated, please rename it to ip6_mode. Addressing
mode
type: str
ip6-other-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_other_flag. Enable/disable
the other IPv6 flag.
type: str
ip6-prefix-list:
description: Deprecated, please rename it to ip6_prefix_list. Ip6-Prefix-List.
elements: dict
suboptions:
autonomous-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to autonomous_flag.
Enable/disable the autonomous flag.
type: str
dnssl:
description: (list) DNS search list option.
type: raw
onlink-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to onlink_flag. Enable/disable
the onlink flag.
type: str
preferred-life-time:
description: Deprecated, please rename it to preferred_life_time.
Preferred life time
type: int
prefix:
description: IPv6 prefix.
type: str
rdnss:
description: (list) Recursive DNS server option.
type: raw
valid-life-time:
description: Deprecated, please rename it to valid_life_time.
Valid life time
type: int
type: list
ip6-prefix-mode:
choices:
- dhcp6
- ra
description: Deprecated, please rename it to ip6_prefix_mode. Assigning
a prefix from DHCP or RA.
type: str
ip6-reachable-time:
description: Deprecated, please rename it to ip6_reachable_time. IPv6
reachable time
type: int
ip6-retrans-time:
description: Deprecated, please rename it to ip6_retrans_time. IPv6
retransmit time
type: int
ip6-send-adv:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_send_adv. Enable/disable
sending advertisements about the inte...
type: str
ip6-subnet:
description: Deprecated, please rename it to ip6_subnet. Subnet to
routing prefix, syntax
type: str
ip6-upstream-interface:
description: Deprecated, please rename it to ip6_upstream_interface.
Interface name providing delegated informa...
type: str
nd-cert:
description: Deprecated, please rename it to nd_cert. Neighbor discovery
certificate.
type: str
nd-cga-modifier:
description: Deprecated, please rename it to nd_cga_modifier. Neighbor
discovery CGA modifier.
type: str
nd-mode:
choices:
- basic
- SEND-compatible
description: Deprecated, please rename it to nd_mode. Neighbor discovery
mode.
type: str
nd-security-level:
description: Deprecated, please rename it to nd_security_level. Neighbor
discovery security level
type: int
nd-timestamp-delta:
description: Deprecated, please rename it to nd_timestamp_delta. Neighbor
discovery timestamp delta value
type: int
nd-timestamp-fuzz:
description: Deprecated, please rename it to nd_timestamp_fuzz. Neighbor
discovery timestamp fuzz factor
type: int
ra-send-mtu:
choices:
- disable
- enable
description: Deprecated, please rename it to ra_send_mtu. Enable/disable
sending link MTU in RA packet.
type: str
unique-autoconf-addr:
choices:
- disable
- enable
description: Deprecated, please rename it to unique_autoconf_addr.
Enable/disable unique auto config address.
type: str
vrip6_link_local:
description: Link-local IPv6 address of virtual router.
type: str
vrrp-virtual-mac6:
choices:
- disable
- enable
description: Deprecated, please rename it to vrrp_virtual_mac6. Enable/disable
virtual MAC for VRRP.
type: str
vrrp6:
description: Vrrp6.
elements: dict
suboptions:
accept-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to accept_mode. Enable/disable
accept mode.
type: str
adv-interval:
description: Deprecated, please rename it to adv_interval. Advertisement
interval
type: int
ignore-default-route:
choices:
- disable
- enable
description: Deprecated, please rename it to ignore_default_route.
Enable/disable ignoring of default r...
type: str
preempt:
choices:
- disable
- enable
description: Enable/disable preempt mode.
type: str
priority:
description: Priority of the virtual router
type: int
start-time:
description: Deprecated, please rename it to start_time. Startup
time
type: int
status:
choices:
- disable
- enable
description: Enable/disable VRRP.
type: str
vrdst6:
description: Monitor the route to this destination.
type: str
vrgrp:
description: VRRP group ID
type: int
vrid:
description: Virtual router identifier
type: int
vrip6:
description: IPv6 address of the virtual router.
type: str
type: list
type: dict
secondary-IP:
choices:
- disable
- enable
description: Deprecated, please rename it to secondary_IP. Secondary-Ip.
type: str
secondaryip:
description: Secondaryip.
elements: dict
suboptions:
allowaccess:
choices:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
- dnp
- ftm
- fabric
- speed-test
description: Management access settings for the secondary IP address.
elements: str
type: list
detectprotocol:
choices:
- ping
- tcp-echo
- udp-echo
description: Protocols used to detect the server.
elements: str
type: list
detectserver:
description: Gateways ping server for this IP.
type: str
gwdetect:
choices:
- disable
- enable
description: Enable/disable detect gateway alive for first.
type: str
ha-priority:
description: Deprecated, please rename it to ha_priority. HA election
priority for the PING server.
type: int
id:
description: ID.
type: int
ip:
description: Secondary IP address of the interface.
type: str
ping-serv-status:
description: Deprecated, please rename it to ping_serv_status. Ping-Serv-Status.
type: int
secip-relay-ip:
description: Deprecated, please rename it to secip_relay_ip. DHCP
relay IP address.
type: str
seq:
description: Seq.
type: int
type: list
vlanid:
description: Vlanid.
type: int
vrrp:
description: No description.
elements: dict
suboptions:
accept-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to accept_mode. Enable/disable
accept mode.
type: str
adv-interval:
description: Deprecated, please rename it to adv_interval. Advertisement
interval
type: int
ignore-default-route:
choices:
- disable
- enable
description: Deprecated, please rename it to ignore_default_route.
Enable/disable ignoring of default route whe...
type: str
preempt:
choices:
- disable
- enable
description: Enable/disable preempt mode.
type: str
priority:
description: Priority of the virtual router
type: int
proxy-arp:
description: Deprecated, please rename it to proxy_arp.
elements: dict
suboptions:
id:
description: ID.
type: int
ip:
description: Set IP addresses of proxy ARP.
type: str
type: list
start-time:
description: Deprecated, please rename it to start_time. Startup time
type: int
status:
choices:
- disable
- enable
description: Enable/disable this VRRP configuration.
type: str
version:
choices:
- '2'
- '3'
description: VRRP version.
type: str
vrdst:
description: (list) No description.
type: raw
vrdst-priority:
description: Deprecated, please rename it to vrdst_priority. Priority
of the virtual router when the virtual ro...
type: int
vrgrp:
description: VRRP group ID
type: int
vrid:
description: Virtual router identifier
type: int
vrip:
description: IP address of the virtual router.
type: str
type: list
type: dict
type: list
interface:
description: No description.
suboptions:
ac-name:
description: Deprecated, please rename it to ac_name. PPPoE server name.
type: str
aggregate:
description: Aggregate.
type: str
aggregate-type:
choices:
- physical
- vxlan
description: Deprecated, please rename it to aggregate_type. Type of aggregation.
type: str
algorithm:
choices:
- L2
- L3
- L4
- LB
- Source-MAC
description: Frame distribution algorithm.
type: str
alias:
description: Alias will be displayed with the interface name to make it easier
to distinguish.
type: str
allowaccess:
choices:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
- dnp
- ftm
- fabric
- speed-test
description: Permitted types of management access to this interface.
elements: str
type: list
annex:
choices:
- a
- b
- j
- bjm
- i
- al
- m
- aijlm
description: Set xDSL annex type.
type: str
ap-discover:
choices:
- disable
- enable
description: Deprecated, please rename it to ap_discover. Enable/disable automatic
registration of unknown FortiAP devices.
type: str
arpforward:
choices:
- disable
- enable
description: Enable/disable ARP forwarding.
type: str
atm-protocol:
choices:
- none
- ipoa
description: Deprecated, please rename it to atm_protocol. ATM protocol.
type: str
auth-cert:
description: Deprecated, please rename it to auth_cert. HTTPS server certificate.
type: str
auth-portal-addr:
description: Deprecated, please rename it to auth_portal_addr. Address of
captive portal.
type: str
auth-type:
choices:
- auto
- pap
- chap
- mschapv1
- mschapv2
description: Deprecated, please rename it to auth_type. PPP authentication
type to use.
type: str
auto-auth-extension-device:
choices:
- disable
- enable
description: Deprecated, please rename it to auto_auth_extension_device. Enable/disable
automatic authorization of dedicated Fo...
type: str
bandwidth-measure-time:
description: Deprecated, please rename it to bandwidth_measure_time. Bandwidth
measure time
type: int
bfd:
choices:
- global
- enable
- disable
description: Bidirectional Forwarding Detection
type: str
bfd-desired-min-tx:
description: Deprecated, please rename it to bfd_desired_min_tx. BFD desired
minimal transmit interval.
type: int
bfd-detect-mult:
description: Deprecated, please rename it to bfd_detect_mult. BFD detection
multiplier.
type: int
bfd-required-min-rx:
description: Deprecated, please rename it to bfd_required_min_rx. BFD required
minimal receive interval.
type: int
broadcast-forticlient-discovery:
choices:
- disable
- enable
description: Deprecated, please rename it to broadcast_forticlient_discovery.
Enable/disable broadcasting FortiClient discovery...
type: str
broadcast-forward:
choices:
- disable
- enable
description: Deprecated, please rename it to broadcast_forward. Enable/disable
broadcast forwarding.
type: str
captive-portal:
description: Deprecated, please rename it to captive_portal. Enable/disable
captive portal.
type: int
cli-conn-status:
description: Deprecated, please rename it to cli_conn_status. Cli-Conn-Status.
type: int
color:
description: Color of icon on the GUI.
type: int
ddns:
choices:
- disable
- enable
description: Ddns.
type: str
ddns-auth:
choices:
- disable
- tsig
description: Deprecated, please rename it to ddns_auth. Ddns-Auth.
type: str
ddns-domain:
description: Deprecated, please rename it to ddns_domain. Ddns-Domain.
type: str
ddns-key:
description: (list or str) Deprecated, please rename it to ddns_key. Ddns-Key.
type: raw
ddns-keyname:
description: Deprecated, please rename it to ddns_keyname. Ddns-Keyname.
type: str
ddns-password:
description: (list) Deprecated, please rename it to ddns_password. Ddns-Password.
type: raw
ddns-server:
choices:
- dhs.org
- dyndns.org
- dyns.net
- tzo.com
- ods.org
- vavic.com
- now.net.cn
- dipdns.net
- easydns.com
- genericDDNS
description: Deprecated, please rename it to ddns_server. Ddns-Server.
type: str
ddns-server-ip:
description: Deprecated, please rename it to ddns_server_ip. Ddns-Server-Ip.
type: str
ddns-sn:
description: Deprecated, please rename it to ddns_sn. Ddns-Sn.
type: str
ddns-ttl:
description: Deprecated, please rename it to ddns_ttl. Ddns-Ttl.
type: int
ddns-username:
description: Deprecated, please rename it to ddns_username. Ddns-Username.
type: str
ddns-zone:
description: Deprecated, please rename it to ddns_zone. Ddns-Zone.
type: str
dedicated-to:
choices:
- none
- management
description: Deprecated, please rename it to dedicated_to. Configure interface
for single purpose.
type: str
default-purdue-level:
choices:
- '1'
- '2'
- '3'
- '4'
- '5'
- '1.5'
- '2.5'
- '3.5'
- '5.5'
description: Deprecated, please rename it to default_purdue_level. Default
purdue level of device detected on this interface.
type: str
defaultgw:
choices:
- disable
- enable
description: Enable to get the gateway IP from the DHCP or PPPoE server.
type: str
description:
description: Description.
type: str
detected-peer-mtu:
description: Deprecated, please rename it to detected_peer_mtu. Detected-Peer-Mtu.
type: int
detectprotocol:
choices:
- ping
- tcp-echo
- udp-echo
description: Protocols used to detect the server.
elements: str
type: list
detectserver:
description: Gateways ping server for this IP.
type: str
device-access-list:
description: (list or str) Deprecated, please rename it to device_access_list.
Device access list.
type: raw
device-identification:
choices:
- disable
- enable
description: Deprecated, please rename it to device_identification. Enable/disable
passively gathering of device identity infor...
type: str
device-identification-active-scan:
choices:
- disable
- enable
description: Deprecated, please rename it to device_identification_active_scan.
Enable/disable active gathering of device ident...
type: str
device-netscan:
choices:
- disable
- enable
description: Deprecated, please rename it to device_netscan. Enable/disable
inclusion of devices detected on this interface in ...
type: str
device-user-identification:
choices:
- disable
- enable
description: Deprecated, please rename it to device_user_identification. Enable/disable
passive gathering of user identity info...
type: str
devindex:
description: Devindex.
type: int
dhcp-broadcast-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_broadcast_flag. Enable/disable
setting of the broadcast flag in messages sent...
type: str
dhcp-classless-route-addition:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_classless_route_addition.
Enable/disable addition of classless static routes ...
type: str
dhcp-client-identifier:
description: Deprecated, please rename it to dhcp_client_identifier. DHCP
client identifier.
type: str
dhcp-relay-agent-option:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_relay_agent_option. Enable/disable
DHCP relay agent option.
type: str
dhcp-relay-circuit-id:
description: Deprecated, please rename it to dhcp_relay_circuit_id. DHCP relay
circuit ID.
type: str
dhcp-relay-interface:
description: Deprecated, please rename it to dhcp_relay_interface. Specify
outgoing interface to reach server.
type: str
dhcp-relay-interface-select-method:
choices:
- auto
- sdwan
- specify
description: Deprecated, please rename it to dhcp_relay_interface_select_method.
Specify how to select outgoing interface to re...
type: str
dhcp-relay-ip:
description: (list) Deprecated, please rename it to dhcp_relay_ip. DHCP relay
IP address.
type: raw
dhcp-relay-link-selection:
description: Deprecated, please rename it to dhcp_relay_link_selection. DHCP
relay link selection.
type: str
dhcp-relay-request-all-server:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_relay_request_all_server.
Enable/disable sending of DHCP requests to all servers.
type: str
dhcp-relay-service:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_relay_service. Enable/disable
allowing this interface to act as a DHCP relay.
type: str
dhcp-relay-source-ip:
description: Deprecated, please rename it to dhcp_relay_source_ip. IP address
used by the DHCP relay as its source IP.
type: str
dhcp-relay-type:
choices:
- regular
- ipsec
description: Deprecated, please rename it to dhcp_relay_type. DHCP relay type
type: str
dhcp-renew-time:
description: Deprecated, please rename it to dhcp_renew_time. DHCP renew time
in seconds
type: int
dhcp-smart-relay:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp_smart_relay. Enable/disable
DHCP smart relay.
type: str
disc-retry-timeout:
description: Deprecated, please rename it to disc_retry_timeout. Time in seconds
to wait before retrying to start a PPPoE disco...
type: int
disconnect-threshold:
description: Deprecated, please rename it to disconnect_threshold. Time in
milliseconds to wait before sending a notification t...
type: int
distance:
description: Distance for routes learned through PPPoE or DHCP, lower distance
indicates preferred route.
type: int
dns-query:
choices:
- disable
- recursive
- non-recursive
description: Deprecated, please rename it to dns_query. Dns-Query.
type: str
dns-server-override:
choices:
- disable
- enable
description: Deprecated, please rename it to dns_server_override. Enable/disable
use DNS acquired by DHCP or PPPoE.
type: str
dns-server-protocol:
choices:
- cleartext
- dot
- doh
description: Deprecated, please rename it to dns_server_protocol.
elements: str
type: list
drop-fragment:
choices:
- disable
- enable
description: Deprecated, please rename it to drop_fragment. Enable/disable
drop fragment packets.
type: str
drop-overlapped-fragment:
choices:
- disable
- enable
description: Deprecated, please rename it to drop_overlapped_fragment. Enable/disable
drop overlapped fragment packets.
type: str
eap-ca-cert:
description: Deprecated, please rename it to eap_ca_cert. EAP CA certificate
name.
type: str
eap-identity:
description: Deprecated, please rename it to eap_identity. EAP identity.
type: str
eap-method:
choices:
- tls
- peap
description: Deprecated, please rename it to eap_method. EAP method.
type: str
eap-password:
description: (list) Deprecated, please rename it to eap_password.
type: raw
eap-supplicant:
choices:
- disable
- enable
description: Deprecated, please rename it to eap_supplicant. Enable/disable
EAP-Supplicant.
type: str
eap-user-cert:
description: Deprecated, please rename it to eap_user_cert. EAP user certificate
name.
type: str
egress-cos:
choices:
- disable
- cos0
- cos1
- cos2
- cos3
- cos4
- cos5
- cos6
- cos7
description: Deprecated, please rename it to egress_cos. Override outgoing
CoS in user VLAN tag.
type: str
egress-shaping-profile:
description: Deprecated, please rename it to egress_shaping_profile. Outgoing
traffic shaping profile.
type: str
eip:
description: Eip.
type: str
endpoint-compliance:
choices:
- disable
- enable
description: Deprecated, please rename it to endpoint_compliance. Enable/disable
endpoint compliance enforcement.
type: str
estimated-downstream-bandwidth:
description: Deprecated, please rename it to estimated_downstream_bandwidth.
Estimated maximum downstream bandwidth
type: int
estimated-upstream-bandwidth:
description: Deprecated, please rename it to estimated_upstream_bandwidth.
Estimated maximum upstream bandwidth
type: int
explicit-ftp-proxy:
choices:
- disable
- enable
description: Deprecated, please rename it to explicit_ftp_proxy. Enable/disable
the explicit FTP proxy on this interface.
type: str
explicit-web-proxy:
choices:
- disable
- enable
description: Deprecated, please rename it to explicit_web_proxy. Enable/disable
the explicit web proxy on this interface.
type: str
external:
choices:
- disable
- enable
description: Enable/disable identifying the interface as an external interface
type: str
fail-action-on-extender:
choices:
- soft-restart
- hard-restart
- reboot
description: Deprecated, please rename it to fail_action_on_extender. Action
on extender when interface fail .
type: str
fail-alert-interfaces:
description: (list or str) Deprecated, please rename it to fail_alert_interfaces.
Names of the FortiGate interfaces to which th...
type: raw
fail-alert-method:
choices:
- link-failed-signal
- link-down
description: Deprecated, please rename it to fail_alert_method. Select link-failed-signal
or link-down method to alert about a ...
type: str
fail-detect:
choices:
- disable
- enable
description: Deprecated, please rename it to fail_detect. Enable/disable fail
detection features for this interface.
type: str
fail-detect-option:
choices:
- detectserver
- link-down
description: Deprecated, please rename it to fail_detect_option. Options for
detecting that this interface has failed.
elements: str
type: list
fdp:
choices:
- disable
- enable
description: Fdp.
type: str
fortiheartbeat:
choices:
- disable
- enable
description: Enable/disable FortiHeartBeat
type: str
fortilink:
choices:
- disable
- enable
description: Enable FortiLink to dedicate this interface to manage other Fortinet
devices.
type: str
fortilink-backup-link:
description: Deprecated, please rename it to fortilink_backup_link. Fortilink-Backup-Link.
type: int
fortilink-neighbor-detect:
choices:
- lldp
- fortilink
description: Deprecated, please rename it to fortilink_neighbor_detect. Protocol
for FortiGate neighbor discovery.
type: str
fortilink-split-interface:
choices:
- disable
- enable
description: Deprecated, please rename it to fortilink_split_interface. Enable/disable
FortiLink split interface to connect mem...
type: str
fortilink-stacking:
choices:
- disable
- enable
description: Deprecated, please rename it to fortilink_stacking. Enable/disable
FortiLink switch-stacking on this interface.
type: str
forward-domain:
description: Deprecated, please rename it to forward_domain. Transparent mode
forward domain.
type: int
forward-error-correction:
choices:
- disable
- enable
- rs-fec
- base-r-fec
- fec-cl91
- fec-cl74
- rs-544
- none
- cl91-rs-fec
- cl74-fc-fec
- auto
description: Deprecated, please rename it to forward_error_correction. Enable/disable
forward error correction
type: str
fp-anomaly:
choices:
- drop_tcp_fin_noack
- pass_winnuke
- pass_tcpland
- pass_udpland
- pass_icmpland
- pass_ipland
- pass_iprr
- pass_ipssrr
- pass_iplsrr
- pass_ipstream
- pass_ipsecurity
- pass_iptimestamp
- pass_ipunknown_option
- pass_ipunknown_prot
- pass_icmp_frag
- pass_tcp_no_flag
- pass_tcp_fin_noack
- drop_winnuke
- drop_tcpland
- drop_udpland
- drop_icmpland
- drop_ipland
- drop_iprr
- drop_ipssrr
- drop_iplsrr
- drop_ipstream
- drop_ipsecurity
- drop_iptimestamp
- drop_ipunknown_option
- drop_ipunknown_prot
- drop_icmp_frag
- drop_tcp_no_flag
description: Deprecated, please rename it to fp_anomaly. Fp-Anomaly.
elements: str
type: list
fp-disable:
choices:
- all
- ipsec
- none
description: Deprecated, please rename it to fp_disable. Fp-Disable.
elements: str
type: list
gateway-address:
description: Deprecated, please rename it to gateway_address. Gateway address
type: str
generic-receive-offload:
choices:
- disable
- enable
description: Deprecated, please rename it to generic_receive_offload.
type: str
gi-gk:
choices:
- disable
- enable
description: Deprecated, please rename it to gi_gk. Enable/disable Gi Gatekeeper.
type: str
gwaddr:
description: Gateway address
type: str
gwdetect:
choices:
- disable
- enable
description: Enable/disable detect gateway alive for first.
type: str
ha-priority:
description: Deprecated, please rename it to ha_priority. HA election priority
for the PING server.
type: int
icmp-accept-redirect:
choices:
- disable
- enable
description: Deprecated, please rename it to icmp_accept_redirect. Enable/disable
ICMP accept redirect.
type: str
icmp-redirect:
choices:
- disable
- enable
description: Deprecated, please rename it to icmp_redirect. Enable/disable
ICMP redirect.
type: str
icmp-send-redirect:
choices:
- disable
- enable
description: Deprecated, please rename it to icmp_send_redirect. Enable/disable
sending of ICMP redirects.
type: str
ident-accept:
choices:
- disable
- enable
description: Deprecated, please rename it to ident_accept. Enable/disable
authentication for this interface.
type: str
idle-timeout:
description: Deprecated, please rename it to idle_timeout. PPPoE auto disconnect
after idle timeout seconds, 0 means no timeout.
type: int
if-mdix:
choices:
- auto
- normal
- crossover
description: Deprecated, please rename it to if_mdix. Interface MDIX mode
type: str
if-media:
choices:
- auto
- copper
- fiber
description: Deprecated, please rename it to if_media. Select interface media
type
type: str
ike-saml-server:
description: Deprecated, please rename it to ike_saml_server. Configure IKE
authentication SAML server.
type: str
in-force-vlan-cos:
description: Deprecated, please rename it to in_force_vlan_cos. In-Force-Vlan-Cos.
type: int
inbandwidth:
description: Bandwidth limit for incoming traffic
type: int
ingress-cos:
choices:
- disable
- cos0
- cos1
- cos2
- cos3
- cos4
- cos5
- cos6
- cos7
description: Deprecated, please rename it to ingress_cos. Override incoming
CoS in user VLAN tag on VLAN interface or assign a ...
type: str
ingress-shaping-profile:
description: Deprecated, please rename it to ingress_shaping_profile. Incoming
traffic shaping profile.
type: str
ingress-spillover-threshold:
description: Deprecated, please rename it to ingress_spillover_threshold.
Ingress Spillover threshold
type: int
interconnect-profile:
choices:
- default
- profile1
- profile2
description: Deprecated, please rename it to interconnect_profile. Set interconnect
profile.
type: str
internal:
description: Implicitly created.
type: int
ip:
description: Interface IPv4 address and subnet mask, syntax
type: str
ip-managed-by-fortiipam:
choices:
- disable
- enable
- inherit-global
description: Deprecated, please rename it to ip_managed_by_fortiipam. Enable/disable
automatic IP address assignment of this in...
type: str
ipmac:
choices:
- disable
- enable
description: Enable/disable IP/MAC binding.
type: str
ips-sniffer-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to ips_sniffer_mode. Enable/disable
the use of this interface as a one-armed sniffer.
type: str
ipunnumbered:
description: Unnumbered IP used for PPPoE interfaces for which no unique local
address is provided.
type: str
ipv6:
description: No description.
suboptions:
autoconf:
choices:
- disable
- enable
description: Enable/disable address auto config.
type: str
cli-conn6-status:
description: Deprecated, please rename it to cli_conn6_status. Cli-Conn6-Status.
type: int
dhcp6-client-options:
choices:
- rapid
- iapd
- iana
- dns
- dnsname
description: Deprecated, please rename it to dhcp6_client_options. Dhcp6-Client-Options.
elements: str
type: list
dhcp6-information-request:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_information_request.
Enable/disable DHCPv6 information request.
type: str
dhcp6-prefix-delegation:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_prefix_delegation.
Enable/disable DHCPv6 prefix delegation.
type: str
dhcp6-prefix-hint:
description: Deprecated, please rename it to dhcp6_prefix_hint. DHCPv6
prefix that will be used as a hint to the upstre...
type: str
dhcp6-prefix-hint-plt:
description: Deprecated, please rename it to dhcp6_prefix_hint_plt. DHCPv6
prefix hint preferred life time
type: int
dhcp6-prefix-hint-vlt:
description: Deprecated, please rename it to dhcp6_prefix_hint_vlt. DHCPv6
prefix hint valid life time
type: int
dhcp6-relay-interface-id:
description: Deprecated, please rename it to dhcp6_relay_interface_id.
DHCP6 relay interface ID.
type: str
dhcp6-relay-ip:
description: Deprecated, please rename it to dhcp6_relay_ip. DHCPv6 relay
IP address.
type: str
dhcp6-relay-service:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_relay_service. Enable/disable
DHCPv6 relay.
type: str
dhcp6-relay-source-interface:
choices:
- disable
- enable
description: Deprecated, please rename it to dhcp6_relay_source_interface.
Enable/disable use of address on this interf...
type: str
dhcp6-relay-source-ip:
description: Deprecated, please rename it to dhcp6_relay_source_ip. IPv6
address used by the DHCP6 relay as its source IP.
type: str
dhcp6-relay-type:
choices:
- regular
description: Deprecated, please rename it to dhcp6_relay_type. DHCPv6
relay type.
type: str
icmp6-send-redirect:
choices:
- disable
- enable
description: Deprecated, please rename it to icmp6_send_redirect. Enable/disable
sending of ICMPv6 redirects.
type: str
interface-identifier:
description: Deprecated, please rename it to interface_identifier. IPv6
interface identifier.
type: str
ip6-address:
description: Deprecated, please rename it to ip6_address. Primary IPv6
address prefix, syntax
type: str
ip6-allowaccess:
choices:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- capwap
- fabric
description: Deprecated, please rename it to ip6_allowaccess. Allow management
access to the interface.
elements: str
type: list
ip6-default-life:
description: Deprecated, please rename it to ip6_default_life. Default
life
type: int
ip6-delegated-prefix-iaid:
description: Deprecated, please rename it to ip6_delegated_prefix_iaid.
IAID of obtained delegated-prefix from the upst...
type: int
ip6-delegated-prefix-list:
description: Deprecated, please rename it to ip6_delegated_prefix_list.
Ip6-Delegated-Prefix-List.
elements: dict
suboptions:
autonomous-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to autonomous_flag. Enable/disable
the autonomous flag.
type: str
delegated-prefix-iaid:
description: Deprecated, please rename it to delegated_prefix_iaid.
IAID of obtained delegated-prefix from the ...
type: int
onlink-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to onlink_flag. Enable/disable
the onlink flag.
type: str
prefix-id:
description: Deprecated, please rename it to prefix_id. Prefix ID.
type: int
rdnss:
description: (list) Recursive DNS server option.
type: raw
rdnss-service:
choices:
- delegated
- default
- specify
description: Deprecated, please rename it to rdnss_service. Recursive
DNS service option.
type: str
subnet:
description: Add subnet ID to routing prefix.
type: str
upstream-interface:
description: Deprecated, please rename it to upstream_interface. Name
of the interface that provides delegated ...
type: str
type: list
ip6-dns-server-override:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_dns_server_override.
Enable/disable using the DNS server acquired by DHCP.
type: str
ip6-extra-addr:
description: Deprecated, please rename it to ip6_extra_addr. Ip6-Extra-Addr.
elements: dict
suboptions:
prefix:
description: IPv6 address prefix.
type: str
type: list
ip6-hop-limit:
description: Deprecated, please rename it to ip6_hop_limit. Hop limit
type: int
ip6-link-mtu:
description: Deprecated, please rename it to ip6_link_mtu. IPv6 link MTU.
type: int
ip6-manage-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_manage_flag. Enable/disable
the managed flag.
type: str
ip6-max-interval:
description: Deprecated, please rename it to ip6_max_interval. IPv6 maximum
interval
type: int
ip6-min-interval:
description: Deprecated, please rename it to ip6_min_interval. IPv6 minimum
interval
type: int
ip6-mode:
choices:
- static
- dhcp
- pppoe
- delegated
description: Deprecated, please rename it to ip6_mode. Addressing mode
type: str
ip6-other-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_other_flag. Enable/disable
the other IPv6 flag.
type: str
ip6-prefix-list:
description: Deprecated, please rename it to ip6_prefix_list. Ip6-Prefix-List.
elements: dict
suboptions:
autonomous-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to autonomous_flag. Enable/disable
the autonomous flag.
type: str
dnssl:
description: (list) DNS search list option.
type: raw
onlink-flag:
choices:
- disable
- enable
description: Deprecated, please rename it to onlink_flag. Enable/disable
the onlink flag.
type: str
preferred-life-time:
description: Deprecated, please rename it to preferred_life_time.
Preferred life time
type: int
prefix:
description: IPv6 prefix.
type: str
rdnss:
description: (list) Recursive DNS server option.
type: raw
valid-life-time:
description: Deprecated, please rename it to valid_life_time. Valid
life time
type: int
type: list
ip6-prefix-mode:
choices:
- dhcp6
- ra
description: Deprecated, please rename it to ip6_prefix_mode. Assigning
a prefix from DHCP or RA.
type: str
ip6-reachable-time:
description: Deprecated, please rename it to ip6_reachable_time. IPv6
reachable time
type: int
ip6-retrans-time:
description: Deprecated, please rename it to ip6_retrans_time. IPv6 retransmit
time
type: int
ip6-send-adv:
choices:
- disable
- enable
description: Deprecated, please rename it to ip6_send_adv. Enable/disable
sending advertisements about the interface.
type: str
ip6-subnet:
description: Deprecated, please rename it to ip6_subnet. Subnet to routing
prefix, syntax
type: str
ip6-upstream-interface:
description: Deprecated, please rename it to ip6_upstream_interface. Interface
name providing delegated information.
type: str
nd-cert:
description: Deprecated, please rename it to nd_cert. Neighbor discovery
certificate.
type: str
nd-cga-modifier:
description: Deprecated, please rename it to nd_cga_modifier. Neighbor
discovery CGA modifier.
type: str
nd-mode:
choices:
- basic
- SEND-compatible
description: Deprecated, please rename it to nd_mode. Neighbor discovery
mode.
type: str
nd-security-level:
description: Deprecated, please rename it to nd_security_level. Neighbor
discovery security level
type: int
nd-timestamp-delta:
description: Deprecated, please rename it to nd_timestamp_delta. Neighbor
discovery timestamp delta value
type: int
nd-timestamp-fuzz:
description: Deprecated, please rename it to nd_timestamp_fuzz. Neighbor
discovery timestamp fuzz factor
type: int
ra-send-mtu:
choices:
- disable
- enable
description: Deprecated, please rename it to ra_send_mtu. Enable/disable
sending link MTU in RA packet.
type: str
unique-autoconf-addr:
choices:
- disable
- enable
description: Deprecated, please rename it to unique_autoconf_addr. Enable/disable
unique auto config address.
type: str
vrip6_link_local:
description: Link-local IPv6 address of virtual router.
type: str
vrrp-virtual-mac6:
choices:
- disable
- enable
description: Deprecated, please rename it to vrrp_virtual_mac6. Enable/disable
virtual MAC for VRRP.
type: str
vrrp6:
description: Vrrp6.
elements: dict
suboptions:
accept-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to accept_mode. Enable/disable
accept mode.
type: str
adv-interval:
description: Deprecated, please rename it to adv_interval. Advertisement
interval
type: int
ignore-default-route:
choices:
- disable
- enable
description: Deprecated, please rename it to ignore_default_route.
Enable/disable ignoring of default route whe...
type: str
preempt:
choices:
- disable
- enable
description: Enable/disable preempt mode.
type: str
priority:
description: Priority of the virtual router
type: int
start-time:
description: Deprecated, please rename it to start_time. Startup time
type: int
status:
choices:
- disable
- enable
description: Enable/disable VRRP.
type: str
vrdst6:
description: Monitor the route to this destination.
type: str
vrgrp:
description: VRRP group ID
type: int
vrid:
description: Virtual router identifier
type: int
vrip6:
description: IPv6 address of the virtual router.
type: str
type: list
type: dict
l2forward:
choices:
- disable
- enable
description: Enable/disable l2 forwarding.
type: str
l2tp-client:
choices:
- disable
- enable
description: Deprecated, please rename it to l2tp_client. Enable/disable this
interface as a Layer 2 Tunnelling Protocol
type: str
lacp-ha-secondary:
choices:
- disable
- enable
description: Deprecated, please rename it to lacp_ha_secondary.
type: str
lacp-ha-slave:
choices:
- disable
- enable
description: Deprecated, please rename it to lacp_ha_slave. LACP HA slave.
type: str
lacp-mode:
choices:
- static
- passive
- active
description: Deprecated, please rename it to lacp_mode. LACP mode.
type: str
lacp-speed:
choices:
- slow
- fast
description: Deprecated, please rename it to lacp_speed. How often the interface
sends LACP messages.
type: str
large-receive-offload:
choices:
- disable
- enable
description: Deprecated, please rename it to large_receive_offload.
type: str
lcp-echo-interval:
description: Deprecated, please rename it to lcp_echo_interval. Time in seconds
between PPPoE Link Control Protocol
type: int
lcp-max-echo-fails:
description: Deprecated, please rename it to lcp_max_echo_fails. Maximum missed
LCP echo messages before disconnect.
type: int
link-up-delay:
description: Deprecated, please rename it to link_up_delay. Number of milliseconds
to wait before considering a link is up.
type: int
listen-forticlient-connection:
choices:
- disable
- enable
description: Deprecated, please rename it to listen_forticlient_connection.
Listen-Forticlient-Connection.
type: str
lldp-network-policy:
description: Deprecated, please rename it to lldp_network_policy. LLDP-MED
network policy profile.
type: str
lldp-reception:
choices:
- disable
- enable
- vdom
description: Deprecated, please rename it to lldp_reception. Enable/disable
Link Layer Discovery Protocol
type: str
lldp-transmission:
choices:
- enable
- disable
- vdom
description: Deprecated, please rename it to lldp_transmission. Enable/disable
Link Layer Discovery Protocol
type: str
log:
choices:
- disable
- enable
description: Log.
type: str
macaddr:
description: Change the interfaces MAC address.
type: str
managed-subnetwork-size:
choices:
- '256'
- '512'
- '1024'
- '2048'
- '4096'
- '8192'
- '16384'
- '32768'
- '65536'
- '32'
- '64'
- '128'
description: Deprecated, please rename it to managed_subnetwork_size. Number
of IP addresses to be allocated by FortiIPAM and u...
type: str
management-ip:
description: Deprecated, please rename it to management_ip. High Availability
in-band management IP address of this interface.
type: str
max-egress-burst-rate:
description: Deprecated, please rename it to max_egress_burst_rate. Max egress
burst rate
type: int
max-egress-rate:
description: Deprecated, please rename it to max_egress_rate. Max egress rate
type: int
measured-downstream-bandwidth:
description: Deprecated, please rename it to measured_downstream_bandwidth.
Measured downstream bandwidth
type: int
measured-upstream-bandwidth:
description: Deprecated, please rename it to measured_upstream_bandwidth.
Measured upstream bandwidth
type: int
mediatype:
choices:
- serdes-sfp
- sgmii-sfp
- cfp2-sr10
- cfp2-lr4
- serdes-copper-sfp
- sr
- cr
- lr
- qsfp28-sr4
- qsfp28-lr4
- qsfp28-cr4
- sr4
- cr4
- lr4
- none
- gmii
- sgmii
- sr2
- lr2
- cr2
- sr8
- lr8
- cr8
description: Select SFP media interface type
type: str
member:
description: (list or str) Physical interfaces that belong to the aggregate
or redundant interface.
type: raw
min-links:
description: Deprecated, please rename it to min_links. Minimum number of
aggregated ports that must be up.
type: int
min-links-down:
choices:
- operational
- administrative
description: Deprecated, please rename it to min_links_down. Action to take
when less than the configured minimum number of lin...
type: str
mirroring-direction:
choices:
- rx
- tx
- both
description: Deprecated, please rename it to mirroring_direction. Port mirroring
direction.
type: str
mirroring-port:
description: Deprecated, please rename it to mirroring_port. Mirroring port.
type: str
mode:
choices:
- static
- dhcp
- pppoe
- pppoa
- ipoa
- eoa
description: Addressing mode
type: str
monitor-bandwidth:
choices:
- disable
- enable
description: Deprecated, please rename it to monitor_bandwidth. Enable monitoring
bandwidth on this interface.
type: str
mtu:
description: MTU value for this interface.
type: int
mtu-override:
choices:
- disable
- enable
description: Deprecated, please rename it to mtu_override. Enable to set a
custom MTU for this interface.
type: str
mux-type:
choices:
- llc-encaps
- vc-encaps
description: Deprecated, please rename it to mux_type. Multiplexer type
type: str
name:
description: Name.
type: str
ndiscforward:
choices:
- disable
- enable
description: Enable/disable NDISC forwarding.
type: str
netbios-forward:
choices:
- disable
- enable
description: Deprecated, please rename it to netbios_forward. Enable/disable
NETBIOS forwarding.
type: str
netflow-sampler:
choices:
- disable
- tx
- rx
- both
description: Deprecated, please rename it to netflow_sampler. Enable/disable
NetFlow on this interface and set the data that Ne...
type: str
np-qos-profile:
description: Deprecated, please rename it to np_qos_profile. NP QoS profile
ID.
type: int
npu-fastpath:
choices:
- disable
- enable
description: Deprecated, please rename it to npu_fastpath. Npu-Fastpath.
type: str
nst:
choices:
- disable
- enable
description: Nst.
type: str
out-force-vlan-cos:
description: Deprecated, please rename it to out_force_vlan_cos. Out-Force-Vlan-Cos.
type: int
outbandwidth:
description: Bandwidth limit for outgoing traffic
type: int
padt-retry-timeout:
description: Deprecated, please rename it to padt_retry_timeout. PPPoE Active
Discovery Terminate
type: int
password:
description: (list) PPPoE accounts password.
type: raw
peer-interface:
description: (list or str) Deprecated, please rename it to peer_interface.
Peer-Interface.
type: raw
phy-mode:
choices:
- auto
- adsl
- vdsl
- adsl-auto
- vdsl2
- adsl2+
- adsl2
- g.dmt
- t1.413
- g.lite
description: Deprecated, please rename it to phy_mode. DSL physical mode.
type: str
ping-serv-status:
description: Deprecated, please rename it to ping_serv_status. Ping-Serv-Status.
type: int
poe:
choices:
- disable
- enable
description: Enable/disable PoE status.
type: str
polling-interval:
description: Deprecated, please rename it to polling_interval. SFlow polling
interval
type: int
port-mirroring:
choices:
- disable
- enable
description: Deprecated, please rename it to port_mirroring. Enable/disable
NP port mirroring.
type: str
pppoe-unnumbered-negotiate:
choices:
- disable
- enable
description: Deprecated, please rename it to pppoe_unnumbered_negotiate. Enable/disable
PPPoE unnumbered negotiation.
type: str
pptp-auth-type:
choices:
- auto
- pap
- chap
- mschapv1
- mschapv2
description: Deprecated, please rename it to pptp_auth_type. PPTP authentication
type.
type: str
pptp-client:
choices:
- disable
- enable
description: Deprecated, please rename it to pptp_client. Enable/disable PPTP
client.
type: str
pptp-password:
description: (list) Deprecated, please rename it to pptp_password. PPTP password.
type: raw
pptp-server-ip:
description: Deprecated, please rename it to pptp_server_ip. PPTP server IP
address.
type: str
pptp-timeout:
description: Deprecated, please rename it to pptp_timeout. Idle timer in minutes
type: int
pptp-user:
description: Deprecated, please rename it to pptp_user. PPTP user name.
type: str
preserve-session-route:
choices:
- disable
- enable
description: Deprecated, please rename it to preserve_session_route. Enable/disable
preservation of session route when dirty.
type: str
priority:
description: Priority of learned routes.
type: int
priority-override:
choices:
- disable
- enable
description: Deprecated, please rename it to priority_override. Enable/disable
fail back to higher priority port once recovered.
type: str
proxy-captive-portal:
choices:
- disable
- enable
description: Deprecated, please rename it to proxy_captive_portal. Enable/disable
proxy captive portal on this interface.
type: str
pvc-atm-qos:
choices:
- cbr
- rt-vbr
- nrt-vbr
description: Deprecated, please rename it to pvc_atm_qos. SFP-DSL ADSL Fallback
PVC ATM QoS.
type: str
pvc-chan:
description: Deprecated, please rename it to pvc_chan. SFP-DSL ADSL Fallback
PVC Channel.
type: int
pvc-crc:
description: Deprecated, please rename it to pvc_crc. SFP-DSL ADSL Fallback
PVC CRC Option
type: int
pvc-pcr:
description: Deprecated, please rename it to pvc_pcr. SFP-DSL ADSL Fallback
PVC Packet Cell Rate in cells
type: int
pvc-scr:
description: Deprecated, please rename it to pvc_scr. SFP-DSL ADSL Fallback
PVC Sustainable Cell Rate in cells
type: int
pvc-vlan-id:
description: Deprecated, please rename it to pvc_vlan_id. SFP-DSL ADSL Fallback
PVC VLAN ID.
type: int
pvc-vlan-rx-id:
description: Deprecated, please rename it to pvc_vlan_rx_id. SFP-DSL ADSL
Fallback PVC VLANID RX.
type: int
pvc-vlan-rx-op:
choices:
- pass-through
- replace
- remove
description: Deprecated, please rename it to pvc_vlan_rx_op. SFP-DSL ADSL
Fallback PVC VLAN RX op.
type: str
pvc-vlan-tx-id:
description: Deprecated, please rename it to pvc_vlan_tx_id. SFP-DSL ADSL
Fallback PVC VLAN ID TX.
type: int
pvc-vlan-tx-op:
choices:
- pass-through
- replace
- remove
description: Deprecated, please rename it to pvc_vlan_tx_op. SFP-DSL ADSL
Fallback PVC VLAN TX op.
type: str
reachable-time:
description: Deprecated, please rename it to reachable_time. IPv4 reachable
time in milliseconds
type: int
redundant-interface:
description: Deprecated, please rename it to redundant_interface. Redundant-Interface.
type: str
remote-ip:
description: Deprecated, please rename it to remote_ip. Remote IP address
of tunnel.
type: str
replacemsg-override-group:
description: Deprecated, please rename it to replacemsg_override_group. Replacement
message override group.
type: str
retransmission:
choices:
- disable
- enable
description: Enable/disable DSL retransmission.
type: str
ring-rx:
description: Deprecated, please rename it to ring_rx. RX ring size.
type: int
ring-tx:
description: Deprecated, please rename it to ring_tx. TX ring size.
type: int
role:
choices:
- lan
- wan
- dmz
- undefined
description: Interface role.
type: str
sample-direction:
choices:
- rx
- tx
- both
description: Deprecated, please rename it to sample_direction. Data that NetFlow
collects
type: str
sample-rate:
description: Deprecated, please rename it to sample_rate. SFlow sample rate
type: int
scan-botnet-connections:
choices:
- disable
- block
- monitor
description: Deprecated, please rename it to scan_botnet_connections. Enable
monitoring or blocking connections to Botnet serve...
type: str
secondary-IP:
choices:
- disable
- enable
description: Deprecated, please rename it to secondary_IP. Enable/disable
adding a secondary IP to this interface.
type: str
secondaryip:
description: Secondaryip.
elements: dict
suboptions:
allowaccess:
choices:
- https
- ping
- ssh
- snmp
- http
- telnet
- fgfm
- auto-ipsec
- radius-acct
- probe-response
- capwap
- dnp
- ftm
- fabric
- speed-test
description: Management access settings for the secondary IP address.
elements: str
type: list
detectprotocol:
choices:
- ping
- tcp-echo
- udp-echo
description: Protocols used to detect the server.
elements: str
type: list
detectserver:
description: Gateways ping server for this IP.
type: str
gwdetect:
choices:
- disable
- enable
description: Enable/disable detect gateway alive for first.
type: str
ha-priority:
description: Deprecated, please rename it to ha_priority. HA election
priority for the PING server.
type: int
id:
description: ID.
type: int
ip:
description: Secondary IP address of the interface.
type: str
ping-serv-status:
description: Deprecated, please rename it to ping_serv_status. Ping-Serv-Status.
type: int
secip-relay-ip:
description: Deprecated, please rename it to secip_relay_ip. DHCP relay
IP address.
type: str
seq:
description: Seq.
type: int
type: list
security-8021x-dynamic-vlan-id:
description: Deprecated, please rename it to security_8021x_dynamic_vlan_id.
VLAN ID for virtual switch.
type: int
security-8021x-master:
description: Deprecated, please rename it to security_8021x_master. '802.'
type: str
security-8021x-member-mode:
choices:
- disable
- switch
description: Deprecated, please rename it to security_8021x_member_mode. '802.'
type: str
security-8021x-mode:
choices:
- default
- dynamic-vlan
- fallback
- slave
description: Deprecated, please rename it to security_8021x_mode. '802.'
type: str
security-exempt-list:
description: Deprecated, please rename it to security_exempt_list. Name of
security-exempt-list.
type: str
security-external-logout:
description: Deprecated, please rename it to security_external_logout. URL
of external authentication logout server.
type: str
security-external-web:
description: Deprecated, please rename it to security_external_web. URL of
external authentication web server.
type: str
security-groups:
description: (list or str) Deprecated, please rename it to security_groups.
User groups that can authenticate with the captive ...
type: raw
security-mac-auth-bypass:
choices:
- disable
- enable
- mac-auth-only
description: Deprecated, please rename it to security_mac_auth_bypass. Enable/disable
MAC authentication bypass.
type: str
security-mode:
choices:
- none
- captive-portal
- 802.1X
description: Deprecated, please rename it to security_mode. Turn on captive
portal authentication for this interface.
type: str
security-redirect-url:
description: Deprecated, please rename it to security_redirect_url. URL redirection
after disclaimer/authentication.
type: str
select-profile-30a-35b:
choices:
- 30A
- 35B
description: Deprecated, please rename it to select_profile_30a_35b. Select
VDSL Profile 30a or 35b.
type: str
service-name:
description: Deprecated, please rename it to service_name. PPPoE service name.
type: str
sflow-sampler:
choices:
- disable
- enable
description: Deprecated, please rename it to sflow_sampler. Enable/disable
sFlow on this interface.
type: str
sfp-dsl:
choices:
- disable
- enable
description: Deprecated, please rename it to sfp_dsl. Enable/disable SFP DSL.
type: str
sfp-dsl-adsl-fallback:
choices:
- disable
- enable
description: Deprecated, please rename it to sfp_dsl_adsl_fallback. Enable/disable
SFP DSL ADSL fallback.
type: str
sfp-dsl-autodetect:
choices:
- disable
- enable
description: Deprecated, please rename it to sfp_dsl_autodetect. Enable/disable
SFP DSL MAC address autodetect.
type: str
sfp-dsl-mac:
description: Deprecated, please rename it to sfp_dsl_mac. SFP DSL MAC address.
type: str
speed:
choices:
- auto
- 10full
- 10half
- 100full
- 100half
- 1000full
- 1000half
- 10000full
- 1000auto
- 10000auto
- 40000full
- 100Gfull
- 25000full
- 40000auto
- 25000auto
- 100Gauto
- 400Gfull
- 400Gauto
- 50000full
- 2500auto
- 5000auto
- 50000auto
- 200Gfull
- 200Gauto
- 100auto
description: Interface speed.
type: str
spillover-threshold:
description: Deprecated, please rename it to spillover_threshold. Egress Spillover
threshold
type: int
src-check:
choices:
- disable
- enable
description: Deprecated, please rename it to src_check. Enable/disable source
IP check.
type: str
status:
choices:
- down
- up
description: Bring the interface up or shut the interface down.
type: str
stp:
choices:
- disable
- enable
description: Enable/disable STP.
type: str
stp-edge:
choices:
- disable
- enable
description: Deprecated, please rename it to stp_edge. Enable/disable as STP
edge port.
type: str
stp-ha-secondary:
choices:
- disable
- enable
- priority-adjust
description: Deprecated, please rename it to stp_ha_secondary. Control STP
behaviour on HA secondary.
type: str
stp-ha-slave:
choices:
- disable
- enable
- priority-adjust
description: Deprecated, please rename it to stp_ha_slave. Control STP behaviour
on HA slave.
type: str
stpforward:
choices:
- disable
- enable
description: Enable/disable STP forwarding.
type: str
stpforward-mode:
choices:
- rpl-all-ext-id
- rpl-bridge-ext-id
- rpl-nothing
description: Deprecated, please rename it to stpforward_mode. Configure STP
forwarding mode.
type: str
strip-priority-vlan-tag:
choices:
- disable
- enable
description: Deprecated, please rename it to strip_priority_vlan_tag. Strip-Priority-Vlan-Tag.
type: str
subst:
choices:
- disable
- enable
description: Enable to always send packets from this interface to a destination
MAC address.
type: str
substitute-dst-mac:
description: Deprecated, please rename it to substitute_dst_mac. Destination
MAC address that all packets are sent to from this...
type: str
sw-algorithm:
choices:
- l2
- l3
- eh
description: Deprecated, please rename it to sw_algorithm. Frame distribution
algorithm for switch.
type: str
swc-first-create:
description: Deprecated, please rename it to swc_first_create. Initial create
for switch-controller VLANs.
type: int
swc-vlan:
description: Deprecated, please rename it to swc_vlan. Swc-Vlan.
type: int
switch:
description: Switch.
type: str
switch-controller-access-vlan:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_access_vlan.
Block FortiSwitch port-to-port traffic.
type: str
switch-controller-arp-inspection:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_arp_inspection.
Enable/disable FortiSwitch ARP inspection.
type: str
switch-controller-auth:
choices:
- radius
- usergroup
description: Deprecated, please rename it to switch_controller_auth. Switch
controller authentication.
type: str
switch-controller-dhcp-snooping:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_dhcp_snooping.
Switch controller DHCP snooping.
type: str
switch-controller-dhcp-snooping-option82:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_dhcp_snooping_option82.
Switch controller DHCP snooping option82.
type: str
switch-controller-dhcp-snooping-verify-mac:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_dhcp_snooping_verify_mac.
Switch controller DHCP snooping verify...
type: str
switch-controller-dynamic:
description: Deprecated, please rename it to switch_controller_dynamic. Integrated
FortiLink settings for managed FortiSwitch.
type: str
switch-controller-feature:
choices:
- none
- default-vlan
- quarantine
- sniffer
- voice
- camera
- rspan
- video
- nac
- nac-segment
description: Deprecated, please rename it to switch_controller_feature. Interfaces
purpose when assigning traffic
type: str
switch-controller-igmp-snooping:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_igmp_snooping.
Switch controller IGMP snooping.
type: str
switch-controller-igmp-snooping-fast-leave:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_igmp_snooping_fast_leave.
Switch controller IGMP snooping fast-l...
type: str
switch-controller-igmp-snooping-proxy:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_igmp_snooping_proxy.
Switch controller IGMP snooping proxy.
type: str
switch-controller-iot-scanning:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_iot_scanning.
Enable/disable managed FortiSwitch IoT scanning.
type: str
switch-controller-learning-limit:
description: Deprecated, please rename it to switch_controller_learning_limit.
Limit the number of dynamic MAC addresses on thi...
type: int
switch-controller-mgmt-vlan:
description: Deprecated, please rename it to switch_controller_mgmt_vlan.
VLAN to use for FortiLink management purposes.
type: int
switch-controller-nac:
description: Deprecated, please rename it to switch_controller_nac. Integrated
NAC settings for managed FortiSwitch.
type: str
switch-controller-netflow-collect:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_netflow_collect.
NetFlow collection and processing.
type: str
switch-controller-offload:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_offload. Enable/disable
managed FortiSwitch routing offload.
type: str
switch-controller-offload-gw:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_offload_gw.
Enable/disable managed FortiSwitch routing offload g...
type: str
switch-controller-offload-ip:
description: Deprecated, please rename it to switch_controller_offload_ip.
IP for routing offload on FortiSwitch.
type: str
switch-controller-offloading:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_offloading.
type: str
switch-controller-offloading-gw:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_offloading_gw.
type: str
switch-controller-offloading-ip:
description: Deprecated, please rename it to switch_controller_offloading_ip.
type: str
switch-controller-radius-server:
description: Deprecated, please rename it to switch_controller_radius_server.
RADIUS server name for this FortiSwitch VLAN.
type: str
switch-controller-rspan-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to switch_controller_rspan_mode.
Stop Layer2 MAC learning and interception of BPDUs a...
type: str
switch-controller-source-ip:
choices:
- outbound
- fixed
description: Deprecated, please rename it to switch_controller_source_ip.
Source IP address used in FortiLink over L3 connections.
type: str
switch-controller-traffic-policy:
description: Deprecated, please rename it to switch_controller_traffic_policy.
Switch controller traffic policy for the VLAN.
type: str
system-id:
description: Deprecated, please rename it to system_id. Define a system ID
for the aggregate interface.
type: str
system-id-type:
choices:
- auto
- user
description: Deprecated, please rename it to system_id_type. Method in which
system ID is generated.
type: str
tc-mode:
choices:
- ptm
- atm
description: Deprecated, please rename it to tc_mode. DSL transfer mode.
type: str
tcp-mss:
description: Deprecated, please rename it to tcp_mss. TCP maximum segment
size.
type: int
trunk:
choices:
- disable
- enable
description: Enable/disable VLAN trunk.
type: str
trust-ip-1:
description: Deprecated, please rename it to trust_ip_1. Trusted host for
dedicated management traffic
type: str
trust-ip-2:
description: Deprecated, please rename it to trust_ip_2. Trusted host for
dedicated management traffic
type: str
trust-ip-3:
description: Deprecated, please rename it to trust_ip_3. Trusted host for
dedicated management traffic
type: str
trust-ip6-1:
description: Deprecated, please rename it to trust_ip6_1. Trusted IPv6 host
for dedicated management traffic
type: str
trust-ip6-2:
description: Deprecated, please rename it to trust_ip6_2. Trusted IPv6 host
for dedicated management traffic
type: str
trust-ip6-3:
description: Deprecated, please rename it to trust_ip6_3. Trusted IPv6 host
for dedicated management traffic
type: str
type:
choices:
- physical
- vlan
- aggregate
- redundant
- tunnel
- wireless
- vdom-link
- loopback
- switch
- hard-switch
- hdlc
- vap-switch
- wl-mesh
- fortilink
- switch-vlan
- fctrl-trunk
- tdm
- fext-wan
- vxlan
- emac-vlan
- geneve
- ssl
- lan-extension
description: Interface type.
type: str
username:
description: Username of the PPPoE account, provided by your ISP.
type: str
vci:
description: Virtual Channel ID
type: int
vectoring:
choices:
- disable
- enable
description: Enable/disable DSL vectoring.
type: str
vindex:
description: Vindex.
type: int
vlan-id:
description: Deprecated, please rename it to vlan_id. Vlan ID
type: int
vlan-op-mode:
choices:
- tag
- untag
- passthrough
description: Deprecated, please rename it to vlan_op_mode. Configure DSL 802.
type: str
vlan-protocol:
choices:
- 8021q
- 8021ad
description: Deprecated, please rename it to vlan_protocol. Ethernet protocol
of VLAN.
type: str
vlanforward:
choices:
- disable
- enable
description: Enable/disable traffic forwarding between VLANs on this interface.
type: str
vlanid:
description: VLAN ID
type: int
vpi:
description: Virtual Path ID
type: int
vrf:
description: Virtual Routing Forwarding ID.
type: int
vrrp:
description: Vrrp.
elements: dict
suboptions:
accept-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to accept_mode. Enable/disable
accept mode.
type: str
adv-interval:
description: Deprecated, please rename it to adv_interval. Advertisement
interval
type: int
ignore-default-route:
choices:
- disable
- enable
description: Deprecated, please rename it to ignore_default_route. Enable/disable
ignoring of default route when checki...
type: str
preempt:
choices:
- disable
- enable
description: Enable/disable preempt mode.
type: str
priority:
description: Priority of the virtual router
type: int
proxy-arp:
description: Deprecated, please rename it to proxy_arp.
elements: dict
suboptions:
id:
description: ID.
type: int
ip:
description: Set IP addresses of proxy ARP.
type: str
type: list
start-time:
description: Deprecated, please rename it to start_time. Startup time
type: int
status:
choices:
- disable
- enable
description: Enable/disable this VRRP configuration.
type: str
version:
choices:
- '2'
- '3'
description: VRRP version.
type: str
vrdst:
description: (list) Monitor the route to this destination.
type: raw
vrdst-priority:
description: Deprecated, please rename it to vrdst_priority. Priority
of the virtual router when the virtual router des...
type: int
vrgrp:
description: VRRP group ID
type: int
vrid:
description: Virtual router identifier
type: int
vrip:
description: IP address of the virtual router.
type: str
type: list
vrrp-virtual-mac:
choices:
- disable
- enable
description: Deprecated, please rename it to vrrp_virtual_mac. Enable/disable
use of virtual MAC for VRRP.
type: str
wccp:
choices:
- disable
- enable
description: Enable/disable WCCP on this interface.
type: str
weight:
description: Default weight for static routes
type: int
wifi-5g-threshold:
description: Deprecated, please rename it to wifi_5g_threshold. Minimal signal
strength to be considered as a good 5G AP.
type: str
wifi-acl:
choices:
- deny
- allow
description: Deprecated, please rename it to wifi_acl. Access control for
MAC addresses in the MAC list.
type: str
wifi-ap-band:
choices:
- any
- 5g-preferred
- 5g-only
description: Deprecated, please rename it to wifi_ap_band. How to select the
AP to connect.
type: str
wifi-auth:
choices:
- PSK
- RADIUS
- radius
- usergroup
description: Deprecated, please rename it to wifi_auth. WiFi authentication.
type: str
wifi-auto-connect:
choices:
- disable
- enable
description: Deprecated, please rename it to wifi_auto_connect. Enable/disable
WiFi network auto connect.
type: str
wifi-auto-save:
choices:
- disable
- enable
description: Deprecated, please rename it to wifi_auto_save. Enable/disable
WiFi network automatic save.
type: str
wifi-broadcast-ssid:
choices:
- disable
- enable
description: Deprecated, please rename it to wifi_broadcast_ssid. Enable/disable
SSID broadcast in the beacon.
type: str
wifi-dns-server1:
description: Deprecated, please rename it to wifi_dns_server1. DNS server
1.
type: str
wifi-dns-server2:
description: Deprecated, please rename it to wifi_dns_server2. DNS server
2.
type: str
wifi-encrypt:
choices:
- TKIP
- AES
description: Deprecated, please rename it to wifi_encrypt. Data encryption.
type: str
wifi-fragment-threshold:
description: Deprecated, please rename it to wifi_fragment_threshold. WiFi
fragment threshold
type: int
wifi-gateway:
description: Deprecated, please rename it to wifi_gateway. IPv4 default gateway
IP address.
type: str
wifi-key:
description: (list) Deprecated, please rename it to wifi_key. WiFi WEP Key.
type: raw
wifi-keyindex:
description: Deprecated, please rename it to wifi_keyindex. WEP key index
type: int
wifi-mac-filter:
choices:
- disable
- enable
description: Deprecated, please rename it to wifi_mac_filter. Enable/disable
MAC filter status.
type: str
wifi-passphrase:
description: (list) Deprecated, please rename it to wifi_passphrase. WiFi
pre-shared key for WPA.
type: raw
wifi-radius-server:
description: Deprecated, please rename it to wifi_radius_server. WiFi RADIUS
server for WPA.
type: str
wifi-rts-threshold:
description: Deprecated, please rename it to wifi_rts_threshold. WiFi RTS
threshold
type: int
wifi-security:
choices:
- None
- WEP64
- wep64
- WEP128
- wep128
- WPA_PSK
- WPA_RADIUS
- WPA
- WPA2
- WPA2_AUTO
- open
- wpa-personal
- wpa-enterprise
- wpa-only-personal
- wpa-only-enterprise
- wpa2-only-personal
- wpa2-only-enterprise
description: Deprecated, please rename it to wifi_security. Wireless access
security of SSID.
type: str
wifi-ssid:
description: Deprecated, please rename it to wifi_ssid. IEEE 802.
type: str
wifi-usergroup:
description: Deprecated, please rename it to wifi_usergroup. WiFi user group
for WPA.
type: str
wins-ip:
description: Deprecated, please rename it to wins_ip. WINS server IP.
type: str
type: dict
name:
description: Name.
required: true
type: str
portal-message-override-group:
description: Deprecated, please rename it to portal_message_override_group.
type: str
radius-server:
description: Deprecated, please rename it to radius_server.
type: str
security:
choices:
- open
- captive-portal
- 8021x
description: No description.
type: str
selected-usergroups:
description: Deprecated, please rename it to selected_usergroups.
type: str
usergroup:
description: No description.
type: str
vdom:
description: Vdom.
type: str
vlanid:
description: Vlanid.
type: int
type: dict
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list