:source: fmgd_system_interface.py
:orphan:
.. _fmgd_system_interface:
fmgd_system_interface -- Configure interfaces.
++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- system_interface - Configure interfaces. type: dict
- ac_name (Alias name: ac-name) Pppoe server name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- aggregate Aggregate. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- aggregate_type (Alias name: aggregate-type) Type of aggregation. type: str choices: [physical, vxlan]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- algorithm Frame distribution algorithm. type: str choices: [L2, L3, L4, LB, Source-MAC, NPU-GRE]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- alias Alias will be displayed with the interface name to make it easier to distinguish. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- allowaccess Permitted types of management access to this interface. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test, icond, scim]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- annex Configure xdsl annex type. type: str choices: [a, b, j, bjm, i, al, m, aijlm, bj]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ap_discover (Alias name: ap-discover) Enable/disable automatic registration of unknown fortiap devices. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- arpforward Enable/disable arp forwarding. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- atm_protocol (Alias name: atm-protocol) Atm protocol. type: str choices: [none, ipoa]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- auth_cert (Alias name: auth-cert) Https server certificate. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- auth_portal_addr (Alias name: auth-portal-addr) Address of captive portal. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- auth_type (Alias name: auth-type) Ppp authentication type to use. type: str choices: [auto, pap, chap, mschapv1, mschapv2]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- auto_auth_extension_device (Alias name: auto-auth-extension-device) Enable/disable automatic authorization of dedicated fortinet extension device on this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- bandwidth_measure_time (Alias name: bandwidth-measure-time) Bandwidth measure time. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- bfd Bidirectional forwarding detection (bfd) settings. type: str choices: [global, enable, disable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- bfd_desired_min_tx (Alias name: bfd-desired-min-tx) Bfd desired minimal transmit interval. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- bfd_detect_mult (Alias name: bfd-detect-mult) Bfd detection multiplier. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- bfd_required_min_rx (Alias name: bfd-required-min-rx) Bfd required minimal receive interval. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- broadcast_forward (Alias name: broadcast-forward) Enable/disable broadcast forwarding. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- captive_portal (Alias name: captive-portal) Enable/disable captive portal. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cli_conn_status (Alias name: cli-conn-status) Cli conn status. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- client_options (Alias name: client-options) Client options. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- code Dhcp client option code. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip Dhcp option ips. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- type Dhcp client option type. type: str choices: [hex, string, ip, fqdn]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- value Dhcp client option value. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- color Color of icon on the gui. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dedicated_to (Alias name: dedicated-to) Configure interface for single purpose. type: str choices: [none, management]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- default_purdue_level (Alias name: default-purdue-level) Default purdue level of device detected on this interface. type: str choices: [1, 2, 3, 4, 5, 1.5, 2.5, 3.5, 5.5]
more...
Supported Version Ranges: v7.4.3 -> latest
- defaultgw Enable to get the gateway ip from the dhcp or pppoe server. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- description Description. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- detected_peer_mtu (Alias name: detected-peer-mtu) Detected peer mtu. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- device_identification (Alias name: device-identification) Enable/disable passively gathering of device identity information about the devices on the network connected to this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- device_user_identification (Alias name: device-user-identification) Enable/disable passive gathering of user identity information about users on this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- devindex Devindex. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_broadcast_flag (Alias name: dhcp-broadcast-flag) Enable/disable setting of the broadcast flag in messages sent by the dhcp client (default = enable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- dhcp_classless_route_addition (Alias name: dhcp-classless-route-addition) Enable/disable addition of classless static routes retrieved from dhcp server. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_client_identifier (Alias name: dhcp-client-identifier) Dhcp client identifier. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_relay_agent_option (Alias name: dhcp-relay-agent-option) Enable/disable dhcp relay agent option. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_relay_allow_no_end_option (Alias name: dhcp-relay-allow-no-end-option) Enable/disable relaying dhcp messages with no end option. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- dhcp_relay_circuit_id (Alias name: dhcp-relay-circuit-id) Dhcp relay circuit id. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- dhcp_relay_interface (Alias name: dhcp-relay-interface) Specify outgoing interface to reach server. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_relay_interface_select_method (Alias name: dhcp-relay-interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_relay_ip (Alias name: dhcp-relay-ip) Dhcp relay ip address. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_relay_link_selection (Alias name: dhcp-relay-link-selection) Dhcp relay link selection. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_relay_request_all_server (Alias name: dhcp-relay-request-all-server) Enable/disable sending of dhcp requests to all servers. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_relay_service (Alias name: dhcp-relay-service) Enable/disable allowing this interface to act as a dhcp relay. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_relay_source_ip (Alias name: dhcp-relay-source-ip) Ip address used by the dhcp relay as its source ip. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- dhcp_relay_type (Alias name: dhcp-relay-type) Dhcp relay type (regular or ipsec). type: str choices: [regular, ipsec]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_renew_time (Alias name: dhcp-renew-time) Dhcp renew time in seconds (300-604800), 0 means use the renew time provided by the server. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp_smart_relay (Alias name: dhcp-smart-relay) Enable/disable dhcp smart relay. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- dhcp_snooping_server_list (Alias name: dhcp-snooping-server-list) Dhcp snooping server list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- name Dhcp server name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- server_ip (Alias name: server-ip) Ip address for dhcp server. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- disc_retry_timeout (Alias name: disc-retry-timeout) Time in seconds to wait before retrying to start a pppoe discovery, 0 means no timeout. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- distance Distance for routes learned through pppoe or dhcp, lower distance indicates preferred route. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dns_server_override (Alias name: dns-server-override) Enable/disable use dns acquired by dhcp or pppoe. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dns_server_protocol (Alias name: dns-server-protocol) Dns transport protocols. type: list choices: [cleartext, dot, doh]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- drop_fragment (Alias name: drop-fragment) Enable/disable drop fragment packets. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- drop_overlapped_fragment (Alias name: drop-overlapped-fragment) Enable/disable drop overlapped fragment packets. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- eap_ca_cert (Alias name: eap-ca-cert) Eap ca certificate name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- eap_identity (Alias name: eap-identity) Eap identity. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- eap_method (Alias name: eap-method) Eap method. type: str choices: [tls, peap]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- eap_password (Alias name: eap-password) Eap password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- eap_supplicant (Alias name: eap-supplicant) Enable/disable eap-supplicant. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- eap_user_cert (Alias name: eap-user-cert) Eap user certificate name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- egress_cos (Alias name: egress-cos) Override outgoing cos in user vlan tag. type: str choices: [disable, cos0, cos1, cos2, cos3, cos4, cos5, cos6, cos7]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- egress_queues (Alias name: egress-queues) Egress queues. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cos0 Cos profile name for cos 0. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cos1 Cos profile name for cos 1. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cos2 Cos profile name for cos 2. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cos3 Cos profile name for cos 3. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cos4 Cos profile name for cos 4. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cos5 Cos profile name for cos 5. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cos6 Cos profile name for cos 6. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cos7 Cos profile name for cos 7. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- egress_shaping_profile (Alias name: egress-shaping-profile) Outgoing traffic shaping profile. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- eip Eip. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- estimated_downstream_bandwidth (Alias name: estimated-downstream-bandwidth) Estimated maximum downstream bandwidth (kbps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- estimated_upstream_bandwidth (Alias name: estimated-upstream-bandwidth) Estimated maximum upstream bandwidth (kbps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- explicit_ftp_proxy (Alias name: explicit-ftp-proxy) Enable/disable the explicit ftp proxy on this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- explicit_web_proxy (Alias name: explicit-web-proxy) Enable/disable the explicit web proxy on this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- external Enable/disable identifying the interface as an external interface (which usually means its connected to the internet). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fail_action_on_extender (Alias name: fail-action-on-extender) Action on fortiextender when interface fail. type: str choices: [soft-restart, hard-restart, reboot]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fail_alert_interfaces (Alias name: fail-alert-interfaces) Names of the fortigate interfaces to which the link failure alert is sent. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fail_alert_method (Alias name: fail-alert-method) Select link-failed-signal or link-down method to alert about a failed link. type: str choices: [link-failed-signal, link-down]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fail_detect (Alias name: fail-detect) Enable/disable fail detection features for this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fail_detect_option (Alias name: fail-detect-option) Options for detecting that this interface has failed. type: list choices: [detectserver, link-down]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fortilink Enable fortilink to dedicate this interface to manage other fortinet devices. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fortilink_backup_link (Alias name: fortilink-backup-link) Fortilink backup link. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fortilink_neighbor_detect (Alias name: fortilink-neighbor-detect) Protocol for fortigate neighbor discovery. type: str choices: [lldp, fortilink]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fortilink_split_interface (Alias name: fortilink-split-interface) Enable/disable fortilink split interface to connect member link to different fortiswitch in stack for uplink redundancy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- forward_domain (Alias name: forward-domain) Transparent mode forward domain. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- forward_error_correction (Alias name: forward-error-correction) Configure forward error correction (fec). type: str choices: [disable, enable, rs-fec, base-r-fec, fec-cl91, fec-cl74, rs-544, none, cl91-rs-fec, cl74-fc-fec, auto, rs-fec544]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- gateway_address (Alias name: gateway-address) Gateway address. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- gi_gk (Alias name: gi-gk) Enable/disable gi gatekeeper. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- icmp_accept_redirect (Alias name: icmp-accept-redirect) Enable/disable icmp accept redirect. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- icmp_send_redirect (Alias name: icmp-send-redirect) Enable/disable sending of icmp redirects. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ident_accept (Alias name: ident-accept) Enable/disable authentication for this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- idle_timeout (Alias name: idle-timeout) Pppoe auto disconnect after idle timeout seconds, 0 means no timeout. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ike_saml_server (Alias name: ike-saml-server) Configure ike authentication saml server. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- inbandwidth Bandwidth limit for incoming traffic (0 - 80000000 kbps), 0 means unlimited. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ingress_cos (Alias name: ingress-cos) Override incoming cos in user vlan tag on vlan interface or assign a priority vlan tag on physical interface. type: str choices: [disable, cos0, cos1, cos2, cos3, cos4, cos5, cos6, cos7]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ingress_shaping_profile (Alias name: ingress-shaping-profile) Incoming traffic shaping profile. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ingress_spillover_threshold (Alias name: ingress-spillover-threshold) Ingress spillover threshold (0 - 16776000 kbps), 0 means unlimited. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- interconnect_profile (Alias name: interconnect-profile) Set interconnect profile. type: str choices: [default, profile1, profile2]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- interface Interface name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- internal Implicitly created. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip Interface ipv4 address and subnet mask, syntax: x. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip_managed_by_fortiipam (Alias name: ip-managed-by-fortiipam) Enable/disable automatic ip address assignment of this interface by fortiipam. type: str choices: [disable, enable, inherit-global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipmac Enable/disable ip/mac binding. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ips_sniffer_mode (Alias name: ips-sniffer-mode) Enable/disable the use of this interface as a one-armed sniffer. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipunnumbered Unnumbered ip used for pppoe interfaces for which no unique local address is provided. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6 Ipv6. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- autoconf Enable/disable address auto config. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cli_conn6_status (Alias name: cli-conn6-status) Cli conn6 status. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp6_client_options (Alias name: dhcp6-client-options) Dhcp6 client options. type: list choices: [rapid, iapd, iana, dns, dnsname]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp6_iapd_list (Alias name: dhcp6-iapd-list) Dhcp6 iapd list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- iaid Identity association identifier. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- prefix_hint (Alias name: prefix-hint) Dhcpv6 prefix that will be used as a hint to the upstream dhcpv6 server. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- prefix_hint_plt (Alias name: prefix-hint-plt) Dhcpv6 prefix hint preferred life time (sec), 0 means unlimited lease time. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- prefix_hint_vlt (Alias name: prefix-hint-vlt) Dhcpv6 prefix hint valid life time (sec). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp6_information_request (Alias name: dhcp6-information-request) Enable/disable dhcpv6 information request. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp6_prefix_delegation (Alias name: dhcp6-prefix-delegation) Enable/disable dhcpv6 prefix delegation. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp6_relay_interface_id (Alias name: dhcp6-relay-interface-id) Dhcp6 relay interface id. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- dhcp6_relay_ip (Alias name: dhcp6-relay-ip) Dhcpv6 relay ip address. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp6_relay_service (Alias name: dhcp6-relay-service) Enable/disable dhcpv6 relay. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp6_relay_source_interface (Alias name: dhcp6-relay-source-interface) Enable/disable use of address on this interface as the source address of the relay message. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp6_relay_source_ip (Alias name: dhcp6-relay-source-ip) Ipv6 address used by the dhcp6 relay as its source ip. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- dhcp6_relay_type (Alias name: dhcp6-relay-type) Dhcpv6 relay type. type: str choices: [regular]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- icmp6_send_redirect (Alias name: icmp6-send-redirect) Enable/disable sending of icmpv6 redirects. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- interface_identifier (Alias name: interface-identifier) Ipv6 interface identifier. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_address (Alias name: ip6-address) Primary ipv6 address prefix. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_allowaccess (Alias name: ip6-allowaccess) Allow management access to the interface. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, capwap, fabric, scim, probe-response]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_default_life (Alias name: ip6-default-life) Default life (sec). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_delegated_prefix_iaid (Alias name: ip6-delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_delegated_prefix_list (Alias name: ip6-delegated-prefix-list) Ip6 delegated prefix list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- autonomous_flag (Alias name: autonomous-flag) Enable/disable the autonomous flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- delegated_prefix_iaid (Alias name: delegated-prefix-iaid) Iaid of obtained delegated-prefix from the upstream interface. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- onlink_flag (Alias name: onlink-flag) Enable/disable the onlink flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- prefix_id (Alias name: prefix-id) Prefix id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- rdnss Recursive dns server option. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- rdnss_service (Alias name: rdnss-service) Recursive dns service option. type: str choices: [delegated, default, specify]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- subnet Add subnet id to routing prefix. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- upstream_interface (Alias name: upstream-interface) Name of the interface that provides delegated information. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dnssl_service (Alias name: dnssl-service) Enable/disable use of domain from delegated prefix for dnssl. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.5 -> latest
- ip6_dns_server_override (Alias name: ip6-dns-server-override) Enable/disable using the dns server acquired by dhcp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_extra_addr (Alias name: ip6-extra-addr) Ip6 extra addr. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- prefix Ipv6 address prefix. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_hop_limit (Alias name: ip6-hop-limit) Hop limit (0 means unspecified). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_link_mtu (Alias name: ip6-link-mtu) Ipv6 link mtu. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_manage_flag (Alias name: ip6-manage-flag) Enable/disable the managed flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_max_interval (Alias name: ip6-max-interval) Ipv6 maximum interval (4 to 1800 sec). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_min_interval (Alias name: ip6-min-interval) Ipv6 minimum interval (3 to 1350 sec). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_mode (Alias name: ip6-mode) Addressing mode (static, dhcp, delegated). type: str choices: [static, dhcp, pppoe, delegated]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_other_flag (Alias name: ip6-other-flag) Enable/disable the other ipv6 flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_prefix_list (Alias name: ip6-prefix-list) Ip6 prefix list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- autonomous_flag (Alias name: autonomous-flag) Enable/disable the autonomous flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dnssl Dns search list option. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- onlink_flag (Alias name: onlink-flag) Enable/disable the onlink flag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- preferred_life_time (Alias name: preferred-life-time) Preferred life time (sec). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- prefix Ipv6 prefix. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- rdnss Recursive dns server option. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- valid_life_time (Alias name: valid-life-time) Valid life time (sec). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_prefix_mode (Alias name: ip6-prefix-mode) Assigning a prefix from dhcp or ra. type: str choices: [dhcp6, ra]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_reachable_time (Alias name: ip6-reachable-time) Ipv6 reachable time (milliseconds; 0 means unspecified). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_retrans_time (Alias name: ip6-retrans-time) Ipv6 retransmit time (milliseconds; 0 means unspecified). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_send_adv (Alias name: ip6-send-adv) Enable/disable sending advertisements about the interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_subnet (Alias name: ip6-subnet) Subnet to routing prefix. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip6_upstream_interface (Alias name: ip6-upstream-interface) Interface name providing delegated information. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- nd_cert (Alias name: nd-cert) Neighbor discovery certificate. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- nd_cga_modifier (Alias name: nd-cga-modifier) Neighbor discovery cga modifier. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- nd_mode (Alias name: nd-mode) Neighbor discovery mode. type: str choices: [basic, SEND-compatible]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- nd_security_level (Alias name: nd-security-level) Neighbor discovery security level (0 - 7; 0 = least secure, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- nd_timestamp_delta (Alias name: nd-timestamp-delta) Neighbor discovery timestamp delta value (1 - 3600 sec; default = 300). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- nd_timestamp_fuzz (Alias name: nd-timestamp-fuzz) Neighbor discovery timestamp fuzz factor (1 - 60 sec; default = 1). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ra_send_mtu (Alias name: ra-send-mtu) Enable/disable sending link mtu in ra packet. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- unique_autoconf_addr (Alias name: unique-autoconf-addr) Enable/disable unique auto config address. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrip6_link_local Link-local ipv6 address of virtual router. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrrp_virtual_mac6 (Alias name: vrrp-virtual-mac6) Enable/disable virtual mac for vrrp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrrp6 Vrrp6. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- accept_mode (Alias name: accept-mode) Enable/disable accept mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- adv_interval (Alias name: adv-interval) Advertisement interval (1 - 255 seconds). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ignore_default_route (Alias name: ignore-default-route) Enable/disable ignoring of default route when checking destination. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- preempt Enable/disable preempt mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- priority Priority of the virtual router (1 - 255). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- start_time (Alias name: start-time) Startup time (1 - 255 seconds). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- status Enable/disable vrrp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrdst6 Monitor the route to this destination. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrgrp Vrrp group id (1 - 65535). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrid Virtual router identifier (1 - 255). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrip6 Ipv6 address of the virtual router. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrdst_priority (Alias name: vrdst-priority) Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- dhcp6_prefix_hint_vlt (Alias name: dhcp6-prefix-hint-vlt) Dhcpv6 prefix hint valid life time (sec). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp6_prefix_hint (Alias name: dhcp6-prefix-hint) Dhcpv6 prefix that will be used as a hint to the upstream dhcpv6 server. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dhcp6_prefix_hint_plt (Alias name: dhcp6-prefix-hint-plt) Dhcpv6 prefix hint preferred life time (sec), 0 means unlimited lease time. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- client_options (Alias name: client-options) Client options. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- code Dhcpv6 option code. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- id Id. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- ip6 Dhcp option ip6s. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- type Dhcpv6 option type. type: str choices: [hex, string, ip6, fqdn]
more...
Supported Version Ranges: v7.6.0 -> latest
- value Dhcpv6 option value (hexadecimal value must be even). type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- ip6_adv_rio (Alias name: ip6-adv-rio) Enable/disable sending advertisements with route information option. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- ip6_dnssl_list (Alias name: ip6-dnssl-list) Ip6 dnssl list. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- dnssl_life_time (Alias name: dnssl-life-time) Dns search list time in seconds (0 - 4294967295, default = 1800). type: int
more...
Supported Version Ranges: v7.6.2 -> latest
- domain Domain name. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- ip6_rdnss_list (Alias name: ip6-rdnss-list) Ip6 rdnss list. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- rdnss Recursive dns server option. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- rdnss_life_time (Alias name: rdnss-life-time) Recursive dns server life time in seconds (0 - 4294967295, default = 1800). type: int
more...
Supported Version Ranges: v7.6.2 -> latest
- ip6_route_list (Alias name: ip6-route-list) Ip6 route list. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- route Ipv6 route. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- route_life_time (Alias name: route-life-time) Route life time in seconds (0 - 65535, default = 1800). type: int
more...
Supported Version Ranges: v7.6.2 -> latest
- route_pref (Alias name: route-pref) Set route preference to the interface (default = medium). type: str choices: [medium, high, low]
more...
Supported Version Ranges: v7.6.2 -> latest
- ip6_route_pref (Alias name: ip6-route-pref) Set route preference to the interface (default = medium). type: str choices: [medium, high, low]
more...
Supported Version Ranges: v7.6.2 -> latest
- l2forward Enable/disable l2 forwarding. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- l2tp_client (Alias name: l2tp-client) Enable/disable this interface as a layer 2 tunnelling protocol (l2tp) client. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- l2tp_client_settings (Alias name: l2tp-client-settings) L2tp client settings. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- auth_type (Alias name: auth-type) L2tp authentication type. type: str choices: [auto, pap, chap, mschapv1, mschapv2]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- defaultgw Enable/disable default gateway. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- distance Distance of learned routes. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- hello_interval (Alias name: hello-interval) L2tp hello message interval in seconds (0 - 3600 sec, default = 60). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip Ip. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mtu L2tp mtu. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- password L2tp password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- peer_host (Alias name: peer-host) L2tp peer host address. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- peer_mask (Alias name: peer-mask) L2tp peer mask. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- peer_port (Alias name: peer-port) L2tp peer port number. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- priority Priority of learned routes. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- user L2tp user name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- lacp_ha_secondary (Alias name: lacp-ha-secondary) Lacp ha secondary member. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- lacp_mode (Alias name: lacp-mode) Lacp mode. type: str choices: [static, passive, active]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- lacp_speed (Alias name: lacp-speed) How often the interface sends lacp messages. type: str choices: [slow, fast]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- lcp_echo_interval (Alias name: lcp-echo-interval) Time in seconds between pppoe link control protocol (lcp) echo requests. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- lcp_max_echo_fails (Alias name: lcp-max-echo-fails) Maximum missed lcp echo messages before disconnect. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- link_up_delay (Alias name: link-up-delay) Number of milliseconds to wait before considering a link is up. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- lldp_network_policy (Alias name: lldp-network-policy) Lldp-med network policy profile. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- lldp_reception (Alias name: lldp-reception) Enable/disable link layer discovery protocol (lldp) reception. type: str choices: [disable, enable, vdom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- lldp_transmission (Alias name: lldp-transmission) Enable/disable link layer discovery protocol (lldp) transmission. type: str choices: [enable, disable, vdom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- macaddr Change the interfaces mac address. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- managed_subnetwork_size (Alias name: managed-subnetwork-size) Number of ip addresses to be allocated by fortiipam and used by this fortigate units dhcp server settings. type: str choices: [32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 4, 8, 16, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, 16777216]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- management_ip (Alias name: management-ip) High availability in-band management ip address of this interface. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- measured_downstream_bandwidth (Alias name: measured-downstream-bandwidth) Measured downstream bandwidth (kbps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- measured_upstream_bandwidth (Alias name: measured-upstream-bandwidth) Measured upstream bandwidth (kbps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mediatype Select sfp media interface type type: str 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, dr, sr-lr, kr]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- member Physical interfaces that belong to the aggregate or redundant interface. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- min_links (Alias name: min-links) Minimum number of aggregated ports that must be up. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- min_links_down (Alias name: min-links-down) Action to take when less than the configured minimum number of links are active. type: str choices: [operational, administrative]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mirroring_direction (Alias name: mirroring-direction) Port mirroring direction. type: str choices: [rx, tx, both]
more...
Supported Version Ranges: v7.4.3 -> latest
- mirroring_filter (Alias name: mirroring-filter) Mirroring filter. type: dict
more...
Supported Version Ranges: v7.4.3 -> latest
- dbg_dump (Alias name: dbg-dump) Debug mirroring filter, driver dump data/mask pdq. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- filter_dport (Alias name: filter-dport) Destinatin port of mirroring filter. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- filter_dstip (Alias name: filter-dstip) Destinatin ip and mask of mirroring filter. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- filter_protocol (Alias name: filter-protocol) Protocol of mirroring filter. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- filter_sport (Alias name: filter-sport) Source port of mirroring filter. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- filter_srcip (Alias name: filter-srcip) Source ip and mask of mirroring filter. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- mirroring_port (Alias name: mirroring-port) Mirroring port. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- mode Addressing mode (static, dhcp, pppoe). type: str choices: [static, dhcp, pppoe, pppoa, ipoa, eoa]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- monitor_bandwidth (Alias name: monitor-bandwidth) Enable monitoring bandwidth on this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mtu Mtu value for this interface. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mtu_override (Alias name: mtu-override) Enable to set a custom mtu for this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mux_type (Alias name: mux-type) Multiplexer type. type: str choices: [llc-encaps, vc-encaps]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- name Name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ndiscforward Enable/disable ndisc forwarding. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- netbios_forward (Alias name: netbios-forward) Enable/disable netbios forwarding. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- netflow_sampler (Alias name: netflow-sampler) Enable/disable netflow on this interface and set the data that netflow collects (rx, tx, or both). type: str choices: [disable, tx, rx, both]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- np_qos_profile (Alias name: np-qos-profile) Np qos profile id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- outbandwidth Bandwidth limit for outgoing traffic (0 - 80000000 kbps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- padt_retry_timeout (Alias name: padt-retry-timeout) Pppoe active discovery terminate (padt) used to terminate sessions after an idle time. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- password Pppoe accounts password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- phy_mode (Alias name: phy-mode) Dsl physical mode. type: str choices: [auto, adsl, vdsl, adsl-auto, vdsl2, adsl2+, adsl2, g.dmt, g-dmt, t1.413, t1-413, g.lite, g-lite]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- poe Enable/disable poe status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- polling_interval (Alias name: polling-interval) Sflow polling interval in seconds (1 - 255). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port_mirroring (Alias name: port-mirroring) Enable/disable np port mirroring. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- pppoe_unnumbered_negotiate (Alias name: pppoe-unnumbered-negotiate) Enable/disable pppoe unnumbered negotiation. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pptp_auth_type (Alias name: pptp-auth-type) Pptp authentication type. type: str choices: [auto, pap, chap, mschapv1, mschapv2]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pptp_client (Alias name: pptp-client) Enable/disable pptp client. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pptp_password (Alias name: pptp-password) Pptp password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pptp_server_ip (Alias name: pptp-server-ip) Pptp server ip address. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pptp_timeout (Alias name: pptp-timeout) Idle timer in minutes (0 for disabled). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pptp_user (Alias name: pptp-user) Pptp user name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- preserve_session_route (Alias name: preserve-session-route) Enable/disable preservation of session route when dirty. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- priority Priority of learned routes. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- priority_override (Alias name: priority-override) Enable/disable fail back to higher priority port once recovered. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- proxy_captive_portal (Alias name: proxy-captive-portal) Enable/disable proxy captive portal on this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pvc_atm_qos (Alias name: pvc-atm-qos) Sfp-dsl adsl fallback pvc atm qos. type: str choices: [cbr, rt-vbr, nrt-vbr, ubr]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pvc_chan (Alias name: pvc-chan) Sfp-dsl adsl fallback pvc channel. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pvc_crc (Alias name: pvc-crc) Sfp-dsl adsl fallback pvc crc option: bit0: sar llc preserve, bit1: ream llc preserve, bit2: ream vc-mux has crc. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pvc_pcr (Alias name: pvc-pcr) Sfp-dsl adsl fallback pvc packet cell rate in cells (0 - 5500). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pvc_scr (Alias name: pvc-scr) Sfp-dsl adsl fallback pvc sustainable cell rate in cells (0 - 5500). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pvc_vlan_id (Alias name: pvc-vlan-id) Sfp-dsl adsl fallback pvc vlan id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pvc_vlan_rx_id (Alias name: pvc-vlan-rx-id) Sfp-dsl adsl fallback pvc vlanid rx. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pvc_vlan_rx_op (Alias name: pvc-vlan-rx-op) Sfp-dsl adsl fallback pvc vlan rx op. type: str choices: [pass-through, replace, remove]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pvc_vlan_tx_id (Alias name: pvc-vlan-tx-id) Sfp-dsl adsl fallback pvc vlan id tx. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pvc_vlan_tx_op (Alias name: pvc-vlan-tx-op) Sfp-dsl adsl fallback pvc vlan tx op. type: str choices: [pass-through, replace, remove]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- reachable_time (Alias name: reachable-time) Ipv4 reachable time in milliseconds (30000 - 3600000, default = 30000). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- redundant_interface (Alias name: redundant-interface) Redundant interface. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- remote_ip (Alias name: remote-ip) Remote ip address of tunnel. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- replacemsg_override_group (Alias name: replacemsg-override-group) Replacement message override group. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- retransmission Enable/disable dsl retransmission. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ring_rx (Alias name: ring-rx) Rx ring size. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ring_tx (Alias name: ring-tx) Tx ring size. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- role Interface role. type: str choices: [lan, wan, dmz, undefined]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sample_direction (Alias name: sample-direction) Data that netflow collects (rx, tx, or both). type: str choices: [rx, tx, both]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sample_rate (Alias name: sample-rate) Sflow sample rate (10 - 99999). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- secondary_IP (Alias name: secondary-IP) Enable/disable adding a secondary ip to this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- secondaryip Secondaryip. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- allowaccess Management access settings for the secondary ip address. type: list choices: [https, ping, ssh, snmp, http, telnet, fgfm, auto-ipsec, radius-acct, probe-response, capwap, dnp, ftm, fabric, speed-test, icond, scim]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip Secondary ip address of the interface. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- secip_relay_ip (Alias name: secip-relay-ip) Dhcp relay ip address. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- security_8021x_dynamic_vlan_id (Alias name: security-8021x-dynamic-vlan-id) Vlan id for virtual switch. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- security_8021x_master (Alias name: security-8021x-master) 802. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- security_8021x_member_mode (Alias name: security-8021x-member-mode) 802. type: str choices: [disable, switch]
more...
Supported Version Ranges: v7.4.3 -> latest
- security_8021x_mode (Alias name: security-8021x-mode) 802. type: str choices: [default, dynamic-vlan, fallback, slave]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- security_exempt_list (Alias name: security-exempt-list) Name of security-exempt-list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- security_external_logout (Alias name: security-external-logout) Url of external authentication logout server. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- security_external_web (Alias name: security-external-web) Url of external authentication web server. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- security_groups (Alias name: security-groups) User groups that can authenticate with the captive portal. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- security_mac_auth_bypass (Alias name: security-mac-auth-bypass) Enable/disable mac authentication bypass. type: str choices: [disable, enable, mac-auth-only]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- security_mode (Alias name: security-mode) Turn on captive portal authentication for this interface. type: str choices: [none, captive-portal, 802.1X]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- security_redirect_url (Alias name: security-redirect-url) Url redirection after disclaimer/authentication. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- select_profile_30a_35b (Alias name: select-profile-30a-35b) Select vdsl profile 30a or 35b. type: str choices: [30A, 35B, 30a, 35b]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- service_name (Alias name: service-name) Pppoe service name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sflow_sampler (Alias name: sflow-sampler) Enable/disable sflow on this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sfp_dsl (Alias name: sfp-dsl) Enable/disable sfp dsl. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sfp_dsl_adsl_fallback (Alias name: sfp-dsl-adsl-fallback) Enable/disable sfp dsl adsl fallback. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sfp_dsl_autodetect (Alias name: sfp-dsl-autodetect) Enable/disable sfp dsl mac address autodetect. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sfp_dsl_mac (Alias name: sfp-dsl-mac) Sfp dsl mac address. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- snmp_index (Alias name: snmp-index) Permanent snmp index of the interface. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- speed Interface speed. type: str choices: [auto, 10full, 10half, 100full, 100half, 1000full, 1000half, 10000full, 1000auto, 10000auto, 40000full, 100Gfull, 25000full, 50000full, 40000auto, 25000auto, 100Gauto, 2500auto, 400Gfull, 400Gauto, 5000auto, 50000auto, 200Gfull, 200Gauto, 100auto]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- spillover_threshold (Alias name: spillover-threshold) Egress spillover threshold (0 - 16776000 kbps), 0 means unlimited. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- src_check (Alias name: src-check) Enable/disable source ip check. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- status Bring the interface up or shut the interface down. type: str choices: [down, up]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- stp Enable/disable stp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- stp_edge (Alias name: stp-edge) Enable/disable as stp edge port. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- stp_ha_secondary (Alias name: stp-ha-secondary) Control stp behavior on ha secondary. type: str choices: [disable, enable, priority-adjust]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- stpforward Enable/disable stp forwarding. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- stpforward_mode (Alias name: stpforward-mode) Configure stp forwarding mode. type: str choices: [rpl-all-ext-id, rpl-bridge-ext-id, rpl-nothing]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- subst Enable to always send packets from this interface to a destination mac address. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- substitute_dst_mac (Alias name: substitute-dst-mac) Destination mac address that all packets are sent to from this interface. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sw_algorithm (Alias name: sw-algorithm) Frame distribution algorithm for switch. type: str choices: [l2, l3, eh, default]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- swc_first_create (Alias name: swc-first-create) Initial create for switch-controller vlans. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- swc_vlan (Alias name: swc-vlan) Swc vlan. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch Switch. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_access_vlan (Alias name: switch-controller-access-vlan) Block fortiswitch port-to-port traffic. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_arp_inspection (Alias name: switch-controller-arp-inspection) Enable/disable/monitor fortiswitch arp inspection. type: str choices: [disable, enable, monitor]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_dhcp_snooping (Alias name: switch-controller-dhcp-snooping) Switch controller dhcp snooping. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_dhcp_snooping_option82 (Alias name: switch-controller-dhcp-snooping-option82) Switch controller dhcp snooping option82. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_dhcp_snooping_verify_mac (Alias name: switch-controller-dhcp-snooping-verify-mac) Switch controller dhcp snooping verify mac. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_dynamic (Alias name: switch-controller-dynamic) Integrated fortilink settings for managed fortiswitch. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_feature (Alias name: switch-controller-feature) Interfaces purpose when assigning traffic (read only). type: str choices: [none, default-vlan, quarantine, sniffer, voice, camera, rspan, video, nac, nac-segment]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_igmp_snooping (Alias name: switch-controller-igmp-snooping) Switch controller igmp snooping. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_igmp_snooping_fast_leave (Alias name: switch-controller-igmp-snooping-fast-leave) Switch controller igmp snooping fast-leave. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_igmp_snooping_proxy (Alias name: switch-controller-igmp-snooping-proxy) Switch controller igmp snooping proxy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_iot_scanning (Alias name: switch-controller-iot-scanning) Enable/disable managed fortiswitch iot scanning. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_learning_limit (Alias name: switch-controller-learning-limit) Limit the number of dynamic mac addresses on this vlan (1 - 128, 0 = no limit, default). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_mgmt_vlan (Alias name: switch-controller-mgmt-vlan) Vlan to use for fortilink management purposes. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_nac (Alias name: switch-controller-nac) Integrated fortilink settings for managed fortiswitch. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_netflow_collect (Alias name: switch-controller-netflow-collect) Netflow collection and processing. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_offload (Alias name: switch-controller-offload) Enable/disable managed fortiswitch routing offload. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- switch_controller_offload_gw (Alias name: switch-controller-offload-gw) Enable/disable managed fortiswitch routing offload gateway. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- switch_controller_offload_ip (Alias name: switch-controller-offload-ip) Ip for routing offload on fortiswitch. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- switch_controller_rspan_mode (Alias name: switch-controller-rspan-mode) Stop layer2 mac learning and interception of bpdus and other packets on this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_source_ip (Alias name: switch-controller-source-ip) Source ip address used in fortilink over l3 connections. type: str choices: [outbound, fixed]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_controller_traffic_policy (Alias name: switch-controller-traffic-policy) Switch controller traffic policy for the vlan. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- system_id (Alias name: system-id) Define a system id for the aggregate interface. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- system_id_type (Alias name: system-id-type) Method in which system id is generated. type: str choices: [auto, user]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tagging Tagging. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- category Tag category. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- name Tagging entry name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tags Tags. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tc_mode (Alias name: tc-mode) Dsl transfer mode. type: str choices: [ptm, atm]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tcp_mss (Alias name: tcp-mss) Tcp maximum segment size. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- trunk Enable/disable vlan trunk. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- trust_ip_1 (Alias name: trust-ip-1) Trusted host for dedicated management traffic (0. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- trust_ip_2 (Alias name: trust-ip-2) Trusted host for dedicated management traffic (0. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- trust_ip_3 (Alias name: trust-ip-3) Trusted host for dedicated management traffic (0. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- trust_ip6_1 (Alias name: trust-ip6-1) Trusted ipv6 host for dedicated management traffic (::/0 for all hosts). type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- trust_ip6_2 (Alias name: trust-ip6-2) Trusted ipv6 host for dedicated management traffic (::/0 for all hosts). type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- trust_ip6_3 (Alias name: trust-ip6-3) Trusted ipv6 host for dedicated management traffic (::/0 for all hosts). type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- type Interface type. type: str 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]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- username Username of the pppoe account, provided by your isp. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vci Virtual channel id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vdom Interface is in this virtual domain (vdom). type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vectoring Enable/disable dsl vectoring. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vindex Vindex. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vlan_id (Alias name: vlan-id) Vlan id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vlan_op_mode (Alias name: vlan-op-mode) Configure dsl 802. type: str choices: [tag, untag, passthrough]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vlan_protocol (Alias name: vlan-protocol) Ethernet protocol of vlan. type: str choices: [8021q, 8021ad]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vlanforward Enable/disable traffic forwarding between vlans on this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vlanid Vlan id (1 - 4094). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vpi Virtual path id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrf Virtual routing forwarding id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrrp Vrrp. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- accept_mode (Alias name: accept-mode) Enable/disable accept mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- adv_interval (Alias name: adv-interval) Advertisement interval (1 - 255 seconds). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ignore_default_route (Alias name: ignore-default-route) Enable/disable ignoring of default route when checking destination. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- preempt Enable/disable preempt mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- priority Priority of the virtual router (1 - 255). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- proxy_arp (Alias name: proxy-arp) Proxy arp. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip Set ip addresses of proxy arp. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- start_time (Alias name: start-time) Startup time (1 - 255 seconds). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- status Enable/disable this vrrp configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- version Vrrp version. type: str choices: [2, 3]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrdst Monitor the route to this destination. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrdst_priority (Alias name: vrdst-priority) Priority of the virtual router when the virtual router destination becomes unreachable (0 - 254). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrgrp Vrrp group id (1 - 65535). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrid Virtual router identifier (1 - 255). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrip Ip address of the virtual router. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrrp_virtual_mac (Alias name: vrrp-virtual-mac) Enable/disable use of virtual mac for vrrp. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wccp Enable/disable wccp on this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- weight Default weight for static routes (if route has no weight configured). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_5g_threshold (Alias name: wifi-5g-threshold) Minimal signal strength to be considered as a good 5g ap. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_acl (Alias name: wifi-acl) Access control for mac addresses in the mac list. type: str choices: [deny, allow]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_ap_band (Alias name: wifi-ap-band) How to select the ap to connect. type: str choices: [any, 5g-preferred, 5g-only]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_auth (Alias name: wifi-auth) Wifi authentication. type: str choices: [PSK, radius, usergroup]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_auto_connect (Alias name: wifi-auto-connect) Enable/disable wifi network auto connect. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_auto_save (Alias name: wifi-auto-save) Enable/disable wifi network automatic save. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_broadcast_ssid (Alias name: wifi-broadcast-ssid) Enable/disable ssid broadcast in the beacon. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_dns_server1 (Alias name: wifi-dns-server1) Dns server 1. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_dns_server2 (Alias name: wifi-dns-server2) Dns server 2. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_encrypt (Alias name: wifi-encrypt) Data encryption. type: str choices: [TKIP, AES]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_fragment_threshold (Alias name: wifi-fragment-threshold) Wifi fragment threshold (800 - 2346). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_gateway (Alias name: wifi-gateway) Ipv4 default gateway ip address. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_key (Alias name: wifi-key) Wifi wep key. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_keyindex (Alias name: wifi-keyindex) Wep key index (1 - 4). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_mac_filter (Alias name: wifi-mac-filter) Enable/disable mac filter status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_networks (Alias name: wifi-networks) Wifi networks. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- obsolete_security_options (Alias name: obsolete-security-options) Enable/disable obsolete security options. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_ca_certificate (Alias name: wifi-ca-certificate) Ca certificate for wpa2/wpa3-enterprise. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- wifi_client_certificate (Alias name: wifi-client-certificate) Client certificate for wpa2/wpa3-enterprise. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- wifi_eap_type (Alias name: wifi-eap-type) Wpa2/wpa3-enterprise eap method. type: str choices: [tls, peap, both]
more...
Supported Version Ranges: v7.4.3 -> latest
- wifi_encrypt (Alias name: wifi-encrypt) Data encryption. type: str choices: [TKIP, AES]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_key (Alias name: wifi-key) Wifi wep key. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_keyindex (Alias name: wifi-keyindex) Wep key index (1 - 4). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_passphrase (Alias name: wifi-passphrase) Wifi pre-shared key for wpa-psk or password for wpa3-sae and wpa2/wpa3-enterprise. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_private_key (Alias name: wifi-private-key) Private key for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- wifi_private_key_password (Alias name: wifi-private-key-password) Password for private key file for wpa2/wpa3-enterprise. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- wifi_security (Alias name: wifi-security) Wireless access security of ssid. type: str choices: [wep64, wep128, open, wpa-personal, wpa-enterprise, wpa-only-personal, wpa2-only-personal, owe, wpa3-sae]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_ssid (Alias name: wifi-ssid) Ieee 802. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_username (Alias name: wifi-username) Username for wpa2/wpa3-enterprise. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- wifi_passphrase (Alias name: wifi-passphrase) Wifi pre-shared key for wpa. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_radius_server (Alias name: wifi-radius-server) Wifi radius server for wpa. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_rts_threshold (Alias name: wifi-rts-threshold) Wifi rts threshold (256 - 2346). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_security (Alias name: wifi-security) Wireless access security of ssid. type: str choices: [None, wep64, 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]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_ssid (Alias name: wifi-ssid) Ieee 802. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wifi_usergroup (Alias name: wifi-usergroup) Wifi user group for wpa. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wins_ip (Alias name: wins-ip) Wins server ip. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- lacp_ha_slave (Alias name: lacp-ha-slave) Lacp ha slave. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- disconnect_threshold (Alias name: disconnect-threshold) Time in milliseconds to wait before sending a notification that this interface is down or disconnected. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- max_egress_rate (Alias name: max-egress-rate) Max egress rate (kbits per sec). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- max_egress_burst_rate (Alias name: max-egress-burst-rate) Max egress burst rate (kbits per sec). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- stp_ha_slave (Alias name: stp-ha-slave) Control stp behaviour on ha slave. type: str choices: [disable, enable, priority-adjust]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fortilink_stacking (Alias name: fortilink-stacking) Enable/disable fortilink switch-stacking on this interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- broadcast_forticlient_discovery (Alias name: broadcast-forticlient-discovery) Enable/disable broadcasting forticlient discovery messages. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> v7.6.2
- netflow_sample_rate (Alias name: netflow-sample-rate) Netflow sample rate. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- netflow_sampler_id (Alias name: netflow-sampler-id) Netflow sampler id. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- pppoe_egress_cos (Alias name: pppoe-egress-cos) Cos in vlan tag for outgoing pppoe/ppp packets. type: str choices: [cos0, cos1, cos2, cos3, cos4, cos5, cos6, cos7]
more...
Supported Version Ranges: v7.4.4 -> latest
- security_ip_auth_bypass (Alias name: security-ip-auth-bypass) Enable/disable ip authentication bypass. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- virtual_mac (Alias name: virtual-mac) Change the interfaces virtual mac address. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- dhcp_relay_vrf_select (Alias name: dhcp-relay-vrf-select) Vrf id used for connection to server. type: int
more...
Supported Version Ranges: v7.6.2 -> latest
- exclude_signatures (Alias name: exclude-signatures) Exclude iot or ot application signatures. type: list choices: [iot, ot]
more...
Supported Version Ranges: v7.6.2 -> latest
- phy_setting (Alias name: phy-setting) Phy setting. type: dict
more...
Supported Version Ranges: v7.4.6 -> v7.4.10, v7.6.3 -> latest
- signal_ok_threshold_value (Alias name: signal-ok-threshold-value) Signal-ok-threshold value(0 - 12). type: int
more...
Supported Version Ranges: v7.4.6 -> v7.4.10, v7.6.3 -> latest
- signal_ok_threshold (Alias name: signal-ok-threshold) Configure the signal strength value at which the fortigate unit detects that the receiving signal is idle or that data is not being received. type: int
more...
Supported Version Ranges: v7.6.5 -> latest
- profiles Set allowed vdsl profiles. type: list choices: [8a, 8b, 8c, 8d, 12a, 12b, 17a, 30a, 35b]
more...
Supported Version Ranges: v7.2.10 -> v7.2.12, v7.4.7 -> v7.4.10, v7.6.3 -> latest
- telemetry_discover (Alias name: telemetry-discover) Enable/disable automatic registration of unknown fortitelemetry agents. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.3 -> latest
- generic_receive_offload (Alias name: generic-receive-offload) Generic receive offload. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- large_receive_offload (Alias name: large-receive-offload) Large receive offload. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- scan_botnet_connections (Alias name: scan-botnet-connections) Enable monitoring or blocking connections to botnet servers through this interface. type: str choices: [disable, block]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10
- multilink Enable/disable ppp multilink support. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.5 -> latest
- mrru Ppp mrru (296 - 65535, default = 1500). type: int
more...
Supported Version Ranges: v7.6.5 -> latest
Notes
-----
.. note::
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure interfaces.
fortinet.fmgdevice.fmgd_system_interface:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
state: present #
system_interface:
name: "your value" # Required variable, string
# ac_name:
# aggregate:
# aggregate_type:
# algorithm:
# alias:
# allowaccess:
# - "https"
# - "ping"
# - "ssh"
# - "snmp"
# - "http"
# - "telnet"
# - "fgfm"
# - "auto-ipsec"
# - "radius-acct"
# - "probe-response"
# - "capwap"
# - "dnp"
# - "ftm"
# - "fabric"
# - "speed-test"
# - "icond"
# - "scim"
# annex:
# ap_discover:
# arpforward:
# atm_protocol:
# auth_cert:
# auth_portal_addr:
# auth_type:
# auto_auth_extension_device:
# bandwidth_measure_time:
# bfd:
# bfd_desired_min_tx:
# bfd_detect_mult:
# bfd_required_min_rx:
# broadcast_forward:
# captive_portal:
# cli_conn_status:
# client_options:
# - code:
# id:
# ip:
# type:
# value:
# color:
# dedicated_to:
# default_purdue_level:
# defaultgw:
# description:
# detected_peer_mtu:
# device_identification:
# device_user_identification:
# devindex:
# dhcp_broadcast_flag:
# dhcp_classless_route_addition:
# dhcp_client_identifier:
# dhcp_relay_agent_option:
# dhcp_relay_allow_no_end_option:
# dhcp_relay_circuit_id:
# dhcp_relay_interface:
# dhcp_relay_interface_select_method:
# dhcp_relay_ip:
# dhcp_relay_link_selection:
# dhcp_relay_request_all_server:
# dhcp_relay_service:
# dhcp_relay_source_ip:
# dhcp_relay_type:
# dhcp_renew_time:
# dhcp_smart_relay:
# dhcp_snooping_server_list:
# - name:
# server_ip:
# disc_retry_timeout:
# distance:
# dns_server_override:
# dns_server_protocol:
# - "cleartext"
# - "dot"
# - "doh"
# drop_fragment:
# drop_overlapped_fragment:
# eap_ca_cert:
# eap_identity:
# eap_method:
# eap_password:
# eap_supplicant:
# eap_user_cert:
# egress_cos:
# egress_queues:
# cos0:
# cos1:
# cos2:
# cos3:
# cos4:
# cos5:
# cos6:
# cos7:
# egress_shaping_profile:
# eip:
# estimated_downstream_bandwidth:
# estimated_upstream_bandwidth:
# explicit_ftp_proxy:
# explicit_web_proxy:
# external:
# fail_action_on_extender:
# fail_alert_interfaces:
# fail_alert_method:
# fail_detect:
# fail_detect_option:
# - "detectserver"
# - "link-down"
# fortilink:
# fortilink_backup_link:
# fortilink_neighbor_detect:
# fortilink_split_interface:
# forward_domain:
# forward_error_correction:
# gateway_address:
# gi_gk:
# icmp_accept_redirect:
# icmp_send_redirect:
# ident_accept:
# idle_timeout:
# ike_saml_server:
# inbandwidth:
# ingress_cos:
# ingress_shaping_profile:
# ingress_spillover_threshold:
# interconnect_profile:
# interface:
# internal:
# ip:
# ip_managed_by_fortiipam:
# ipmac:
# ips_sniffer_mode:
# ipunnumbered:
# ipv6:
# autoconf:
# cli_conn6_status:
# dhcp6_client_options:
# - "rapid"
# - "iapd"
# - "iana"
# - "dns"
# - "dnsname"
# dhcp6_iapd_list:
# - iaid:
# prefix_hint:
# prefix_hint_plt:
# prefix_hint_vlt:
# dhcp6_information_request:
# dhcp6_prefix_delegation:
# dhcp6_relay_interface_id:
# dhcp6_relay_ip:
# dhcp6_relay_service:
# dhcp6_relay_source_interface:
# dhcp6_relay_source_ip:
# dhcp6_relay_type:
# icmp6_send_redirect:
# interface_identifier:
# ip6_address:
# ip6_allowaccess:
# - "https"
# - "ping"
# - "ssh"
# - "snmp"
# - "http"
# - "telnet"
# - "fgfm"
# - "capwap"
# - "fabric"
# - "scim"
# - "probe-response"
# ip6_default_life:
# ip6_delegated_prefix_iaid:
# ip6_delegated_prefix_list:
# - autonomous_flag:
# delegated_prefix_iaid:
# onlink_flag:
# prefix_id:
# rdnss:
# rdnss_service:
# subnet:
# upstream_interface:
# dnssl_service:
# ip6_dns_server_override:
# ip6_extra_addr:
# - prefix:
# ip6_hop_limit:
# ip6_link_mtu:
# ip6_manage_flag:
# ip6_max_interval:
# ip6_min_interval:
# ip6_mode:
# ip6_other_flag:
# ip6_prefix_list:
# - autonomous_flag:
# dnssl:
# onlink_flag:
# preferred_life_time:
# prefix:
# rdnss:
# valid_life_time:
# ip6_prefix_mode:
# ip6_reachable_time:
# ip6_retrans_time:
# ip6_send_adv:
# ip6_subnet:
# ip6_upstream_interface:
# nd_cert:
# nd_cga_modifier:
# nd_mode:
# nd_security_level:
# nd_timestamp_delta:
# nd_timestamp_fuzz:
# ra_send_mtu:
# unique_autoconf_addr:
# vrip6_link_local:
# vrrp_virtual_mac6:
# vrrp6:
# - accept_mode:
# adv_interval:
# ignore_default_route:
# preempt:
# priority:
# start_time:
# status:
# vrdst6:
# vrgrp:
# vrid:
# vrip6:
# vrdst_priority:
# dhcp6_prefix_hint_vlt:
# dhcp6_prefix_hint:
# dhcp6_prefix_hint_plt:
# client_options:
# - code:
# id:
# ip6:
# type:
# value:
# ip6_adv_rio:
# ip6_dnssl_list:
# - dnssl_life_time:
# domain:
# ip6_rdnss_list:
# - rdnss:
# rdnss_life_time:
# ip6_route_list:
# - route:
# route_life_time:
# route_pref:
# ip6_route_pref:
# l2forward:
# l2tp_client:
# l2tp_client_settings:
# auth_type:
# defaultgw:
# distance:
# hello_interval:
# ip:
# mtu:
# password:
# peer_host:
# peer_mask:
# peer_port:
# priority:
# user:
# lacp_ha_secondary:
# lacp_mode:
# lacp_speed:
# lcp_echo_interval:
# lcp_max_echo_fails:
# link_up_delay:
# lldp_network_policy:
# lldp_reception:
# lldp_transmission:
# macaddr:
# managed_subnetwork_size:
# management_ip:
# measured_downstream_bandwidth:
# measured_upstream_bandwidth:
# mediatype:
# member:
# min_links:
# min_links_down:
# mirroring_direction:
# mirroring_filter:
# dbg_dump:
# filter_dport:
# filter_dstip:
# filter_protocol:
# filter_sport:
# filter_srcip:
# mirroring_port:
# mode:
# monitor_bandwidth:
# mtu:
# mtu_override:
# mux_type:
# ndiscforward:
# netbios_forward:
# netflow_sampler:
# np_qos_profile:
# outbandwidth:
# padt_retry_timeout:
# password:
# phy_mode: