fortiswitch_system_settings – Settings in Fortinet’s FortiSwitch
New in version 1.0.0.
Synopsis
This module is able to configure a FortiSwitch device by allowing the user to set and modify system feature and settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.14
FortiSW Version Compatibility
| Supported Version Ranges | |
| fortiswitch_system_settings | v7.0.0 -> latest |
Parameters
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- system_settings - Settings. type: dict
- allow_subnet_overlap - Allow one interface subnet overlap with other interfaces. type: str choices: enable, disable
- asymroute - Asymmetric route. type: str choices: enable, disable
- asymroute6 - Asymmetric route6. type: str choices: enable, disable
- bfd - Enable Bidirectional Forwarding Detection (BFD) on all interfaces. type: str choices: enable, disable
- bfd_desired_min_tx - BFD desired minimal tx interval. type: int
- bfd_detect_mult - BFD detection multiplier. type: int
- bfd_dont_enforce_src_port - Verify Source Port of BFD Packets. type: str choices: enable, disable
- bfd_required_min_rx - BFD required minimal rx interval. type: int
- comments - Vd comments. type: str
- device - Interface. type: str
- ecmp_max_paths - Maximum number of ECMP next-hops. type: int
- gateway - Default gateway ip address. type: str
- ip - IP address and netmask. type: str
- ip_ecmp_mode - IP ecmp mode. type: str choices: source-ip-based, dst-ip-based, port-based
- manageip - IP address and netmask. type: str
- multicast_forward - Multicast forwarding. type: str choices: enable, disable
- multicast_skip_policy - Skip policy check, and allow multicast through. type: str choices: enable, disable
- multicast_ttl_notchange - Multicast ttl not change. type: str choices: enable, disable
- opmode - Firewall operation mode. type: str choices: nat
- per_ip_bandwidth - Per-ip-bandwidth disable. type: str choices: disable, enable
- sccp_port - TCP port the SCCP proxy will monitor for SCCP traffic. type: int
- sip_helper - Helper to add dynamic sip firewall allow rule. type: str choices: enable, disable
- sip_nat_trace - Add original IP if NATed. type: str choices: enable, disable
- sip_tcp_port - TCP port the SIP proxy will monitor for SIP traffic. type: int
- sip_udp_port - UDP port the SIP proxy will monitor for SIP traffic. type: int
- status - Enable/disable this VDOM. type: str choices: enable, disable
- strict_src_check - Strict source verification. type: str choices: enable, disable
- utf8_spam_tagging - Convert spam tags to UTF8 for better non-ascii character support. type: str choices: enable, disable
- vpn_stats_log - Enable periodic VPN log statistics. type: str choices: ipsec, pptp, l2tp, ssl
- vpn_stats_period - Period to send VPN log statistics (seconds). type: int
- wccp_cache_engine - Enable wccp cache engine or not. type: str choices: enable, disable
Examples
- name: Settings.
fortinet.fortiswitch.fortiswitch_system_settings:
system_settings:
allow_subnet_overlap: "enable"
asymroute: "enable"
asymroute6: "enable"
bfd: "enable"
bfd_desired_min_tx: "7"
bfd_detect_mult: "8"
bfd_dont_enforce_src_port: "enable"
bfd_required_min_rx: "10"
comments: "<your_own_value>"
device: "<your_own_value> (source system.interface.name)"
ecmp_max_paths: "13"
gateway: "<your_own_value>"
ip: "<your_own_value>"
ip_ecmp_mode: "source-ip-based"
manageip: "<your_own_value>"
multicast_forward: "enable"
multicast_skip_policy: "enable"
multicast_ttl_notchange: "enable"
opmode: "nat"
per_ip_bandwidth: "disable"
sccp_port: "23"
sip_helper: "enable"
sip_nat_trace: "enable"
sip_tcp_port: "26"
sip_udp_port: "27"
status: "enable"
strict_src_check: "enable"
utf8_spam_tagging: "enable"
vpn_stats_log: "ipsec"
vpn_stats_period: "32"
wccp_cache_engine: "enable"
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortiSwitch image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
- http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiSwitch returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
- status - Indication of the operation's result returned: always type: str sample: success
- version - Version of the FortiSwitch returned: always type: str sample: v7.0.0
Status
This module is not guaranteed to have a backwards compatible interface.