:source: fmgr_extensioncontroller_extenderprofile.py
:orphan:
.. _fmgr_extensioncontroller_extenderprofile:
fmgr_extensioncontroller_extenderprofile -- FortiExtender extender profile configuration.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.2.0
.. warning::
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name``
- New argument name starting in 3.0.0: ``var_name``
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. 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.1 -> 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
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- extensioncontroller_extenderprofile - FortiExtender extender profile configuration. type: dict
- allowaccess Control management access to the managed extender. type: list choices: [https, ping, ssh, snmp, http, telnet]
more...
Supported Version Ranges: v7.2.1 -> latest
- bandwidth_limit (Alias name: bandwidth-limit) Fortiextender lan extension bandwidth limit (mbps). type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- cellular Cellular. type: dict
more...
Supported Version Ranges: v7.2.1 -> latest
- controller_report (Alias name: controller-report) Controller report. type: dict
more...
Supported Version Ranges: v7.2.1 -> latest
- interval Controller report interval. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- signal_threshold (Alias name: signal-threshold) Controller report signal threshold. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- status Fortiextender controller report status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- dataplan Dataplan names. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- modem1 Modem1. type: dict
more...
Supported Version Ranges: v7.2.1 -> latest
- auto_switch (Alias name: auto-switch) Auto switch. type: dict
more...
Supported Version Ranges: v7.2.1 -> latest
- dataplan Automatically switch based on data usage. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- disconnect Auto switch by disconnect. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- disconnect_period (Alias name: disconnect-period) Automatically switch based on disconnect period. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- disconnect_threshold (Alias name: disconnect-threshold) Automatically switch based on disconnect threshold. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- signal Automatically switch based on signal strength. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- switch_back (Alias name: switch-back) Auto switch with switch back multi-options. type: list choices: [time, timer]
more...
Supported Version Ranges: v7.2.1 -> latest
- switch_back_time (Alias name: switch-back-time) Automatically switch over to preferred sim/carrier at a specified time in utc (hh:mm). type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- switch_back_timer (Alias name: switch-back-timer) Automatically switch over to preferred sim/carrier after the given time (3600 - 2147483647 sec). type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- conn_status (Alias name: conn-status) Conn status. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- default_sim (Alias name: default-sim) Default sim selection. type: str choices: [sim1, sim2, carrier, cost]
more...
Supported Version Ranges: v7.2.1 -> latest
- gps Fortiextender gps enable/disable. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- modem_id (Alias name: modem-id) Modem id. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- preferred_carrier (Alias name: preferred-carrier) Preferred carrier. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- redundant_intf (Alias name: redundant-intf) Redundant interface. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- redundant_mode (Alias name: redundant-mode) Fortiextender mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- sim1_pin (Alias name: sim1-pin) Sim #1 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- sim1_pin_code (Alias name: sim1-pin-code) Sim #1 pin password. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- sim2_pin (Alias name: sim2-pin) Sim #2 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- sim2_pin_code (Alias name: sim2-pin-code) Sim #2 pin password. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- multiple_PDN (Alias name: multiple-PDN) Multiple-pdn enable/disable. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- pdn1_dataplan (Alias name: pdn1-dataplan) Pdn1-dataplan. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- pdn2_dataplan (Alias name: pdn2-dataplan) Pdn2-dataplan. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- pdn3_dataplan (Alias name: pdn3-dataplan) Pdn3-dataplan. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- pdn4_dataplan (Alias name: pdn4-dataplan) Pdn4-dataplan. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- modem2 Modem2. type: dict
more...
Supported Version Ranges: v7.2.1 -> latest
- auto_switch (Alias name: auto-switch) Auto switch. type: dict
more...
Supported Version Ranges: v7.2.1 -> latest
- dataplan Automatically switch based on data usage. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- disconnect Auto switch by disconnect. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- disconnect_period (Alias name: disconnect-period) Automatically switch based on disconnect period. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- disconnect_threshold (Alias name: disconnect-threshold) Automatically switch based on disconnect threshold. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- signal Automatically switch based on signal strength. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- switch_back (Alias name: switch-back) Auto switch with switch back multi-options. type: list choices: [time, timer]
more...
Supported Version Ranges: v7.2.1 -> latest
- switch_back_time (Alias name: switch-back-time) Automatically switch over to preferred sim/carrier at a specified time in utc (hh:mm). type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- switch_back_timer (Alias name: switch-back-timer) Automatically switch over to preferred sim/carrier after the given time (3600 - 2147483647 sec). type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- conn_status (Alias name: conn-status) Conn status. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- default_sim (Alias name: default-sim) Default sim selection. type: str choices: [sim1, sim2, carrier, cost]
more...
Supported Version Ranges: v7.2.1 -> latest
- gps Fortiextender gps enable/disable. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- modem_id (Alias name: modem-id) Modem id. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- preferred_carrier (Alias name: preferred-carrier) Preferred carrier. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- redundant_intf (Alias name: redundant-intf) Redundant interface. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- redundant_mode (Alias name: redundant-mode) Fortiextender mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- sim1_pin (Alias name: sim1-pin) Sim #1 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- sim1_pin_code (Alias name: sim1-pin-code) Sim #1 pin password. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- sim2_pin (Alias name: sim2-pin) Sim #2 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- sim2_pin_code (Alias name: sim2-pin-code) Sim #2 pin password. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- multiple_PDN (Alias name: multiple-PDN) Multiple-pdn enable/disable. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- pdn1_dataplan (Alias name: pdn1-dataplan) Pdn1-dataplan. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- pdn2_dataplan (Alias name: pdn2-dataplan) Pdn2-dataplan. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- pdn3_dataplan (Alias name: pdn3-dataplan) Pdn3-dataplan. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- pdn4_dataplan (Alias name: pdn4-dataplan) Pdn4-dataplan. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- sms_notification (Alias name: sms-notification) Sms notification. type: dict
more...
Supported Version Ranges: v7.2.1 -> latest
- alert Alert. type: dict
more...
Supported Version Ranges: v7.2.1 -> latest
- data_exhausted (Alias name: data-exhausted) Display string when data exhausted. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- fgt_backup_mode_switch (Alias name: fgt-backup-mode-switch) Display string when fortigate backup mode switched. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- low_signal_strength (Alias name: low-signal-strength) Display string when signal strength is low. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- mode_switch (Alias name: mode-switch) Display string when mode is switched. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- os_image_fallback (Alias name: os-image-fallback) Display string when falling back to a previous os image. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- session_disconnect (Alias name: session-disconnect) Display string when session disconnected. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- system_reboot (Alias name: system-reboot) Display string when system rebooted. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- receiver Receiver. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- alert Alert multi-options. type: list choices: [system-reboot, data-exhausted, session-disconnect, low-signal-strength, mode-switch, os-image-fallback, fgt-backup-mode-switch]
more...
Supported Version Ranges: v7.2.1 -> latest
- name Fortiextender sms notification receiver name. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- phone_number (Alias name: phone-number) Receiver phone number. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- status Sms notification receiver status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- status Fortiextender sms notification status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- enforce_bandwidth (Alias name: enforce-bandwidth) Enable/disable enforcement of bandwidth on lan extension interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- extension Extension option. type: str choices: [wan-extension, lan-extension]
more...
Supported Version Ranges: v7.2.1 -> latest
- id Id. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- lan_extension (Alias name: lan-extension) Lan extension. type: dict
more...
Supported Version Ranges: v7.2.1 -> latest
- backhaul Backhaul. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- name Fortiextender lan extension backhaul name. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- port Fortiextender uplink port. type: str choices: [wan, lte1, lte2, port1, port2, port3, port4, port5, sfp]
more...
Supported Version Ranges: v7.2.1 -> latest
- role Fortiextender uplink port. type: str choices: [primary, secondary]
more...
Supported Version Ranges: v7.2.1 -> latest
- weight Wrr weight parameter. type: int
more...
Supported Version Ranges: v7.2.1 -> latest
- health_check_fail_cnt (Alias name: health-check-fail-cnt) Number of failures before the link is considered dead (1 - 10, default = 5). type: int
more...
Supported Version Ranges: v7.6.5 -> latest
- health_check_interval (Alias name: health-check-interval) Health monitoring interval in seconds (1 - 3600, default = 5). type: int
more...
Supported Version Ranges: v7.6.5 -> latest
- health_check_probe_cnt (Alias name: health-check-probe-cnt) Number of health monitoring probes to send within an interval (1 - 10, default = 1). type: int
more...
Supported Version Ranges: v7.6.5 -> latest
- health_check_probe_tm (Alias name: health-check-probe-tm) Health monitoring probe timeout in seconds (1 - 10, default = 2). type: int
more...
Supported Version Ranges: v7.6.5 -> latest
- health_check_recovery_cnt (Alias name: health-check-recovery-cnt) Number of successful checks before the link is considered alive (1 - 10, default = 5). type: int
more...
Supported Version Ranges: v7.6.5 -> latest
- backhaul_interface (Alias name: backhaul-interface) Ipsec phase1 interface. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- backhaul_ip (Alias name: backhaul-ip) Ipsec phase1 ipv4/fqdn. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- ipsec_tunnel (Alias name: ipsec-tunnel) Ipsec tunnel name. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- link_loadbalance (Alias name: link-loadbalance) Lan extension link load balance strategy. type: str choices: [activebackup, loadbalance]
more...
Supported Version Ranges: v7.2.1 -> latest
- downlinks Downlinks. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- name Fortiextender lan extension downlink config entry name. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- port Fortiextender lan extension downlink port. type: str choices: [port1, port2, port3, port4, port5, lan1, lan2, lan]
more...
Supported Version Ranges: v7.6.0 -> latest
- pvid Fortiextender lan extension downlink pvid. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- type Fortiextender lan extension downlink type [port/vap]. type: str choices: [port, vap]
more...
Supported Version Ranges: v7.6.0 -> latest
- vap Fortiextender lan extension downlink vap. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- vids Fortiextender lan extension downlink vids. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- traffic_split_services (Alias name: traffic-split-services) Traffic split services. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- address Address selection. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- name Fortiextender lan extension tunnel split entry name. type: str
more...
Supported Version Ranges: v7.6.2 -> latest
- service Service selection. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- vsdb Select vsdb [enable/disable]. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- login_password (Alias name: login-password) Set the managed extenders administrator password. type: list
more...
Supported Version Ranges: v7.2.1 -> latest
- login_password_change (Alias name: login-password-change) Change or reset the administrator password of a managed extender (yes, default, or no, default = no). type: str choices: [no, yes, default]
more...
Supported Version Ranges: v7.2.1 -> latest
- model Model. type: str choices: [FX201E, FX211E, FX200F, FXA11F, FXE11F, FXA21F, FXE21F, FXA22F, FXE22F, FX212F, FX311F, FX312F, FX511F, FVG21F, FVA21F, FVG22F, FVA22F, FX04DA, FX04DN, FX04DI, FXR51G, FG, BS10FW, BS20GW, BS20GN, FXN51G, FXW51G, FVG51G, FXE11G, FX211G]
more...
Supported Version Ranges: v7.2.1 -> latest
- name Fortiextender profile name. type: str
more...
Supported Version Ranges: v7.2.1 -> latest
- _is_factory_setting Is factory setting. type: str choices: [disable, enable, ext] default: disable
more...
Supported Version Ranges: v7.4.0 -> latest
- wifi Wifi. type: dict
more...
Supported Version Ranges: v7.4.3 -> latest
- DFS Wi-fi 5g radio dfs channel enable/disable. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- country Country in which this fex will operate (default = na). type: str choices: [AL, DZ, AR, AM, AU, AT, AZ, BH, BD, BY, BE, BZ, BO, BA, BR, BN, BG, CA, CL, CN, CO, CR, HR, CY, CZ, DK, DO, EC, EG, SV, EE, FI, FR, GE, DE, GR, GT, HN, HK, HU, IS, IN, ID, IE, IL, IT, JM, JP, JO, KZ, KE, KR, KW, LV, LB, LI, LT, LU, MO, MK, MY, MT, MX, MC, MA, NP, NL, AN, NZ, NO, OM, PK, PA, PG, PE, PH, PL, PT, PR, QA, RO, RU, SA, SG, SK, SI, ZA, ES, LK, SE, CH, TW, TH, TT, TN, TR, AE, UA, GB, US, PS, UY, UZ, VE, VN, YE, ZW, NA, BS, VC, KH, MV, AF, NG, TZ, ZM, SN, CI, GH, CM, MW, AO, GA, ML, BJ, MG, TD, BW, LY, RW, MZ, GM, LS, MU, CG, UG, BF, SL, SO, CD, NE, CF, SZ, TG, LR, MR, DJ, RE, RS, ME, IQ, MD, KY, BB, BM, TC, VI, PM, MF, GD, IM, FO, GI, GL, TM, MN, VU, FJ, LA, GU, WF, MH, BT, FM, PF, NI, PY, HT, GY, AW, KN, GF, AS, MP, PW, MM, LC, GP, ET, SR, CX, DM, MQ, YT, BL, --, TL]
more...
Supported Version Ranges: v7.4.3 -> latest
- radio_1 (Alias name: radio-1) Radio 1. type: dict
more...
Supported Version Ranges: v7.4.3 -> latest
- d80211d (Alias name: 80211d) Enable/disable wi-fi 802. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- band Wi-fi band selection 2. type: str choices: [2.4GHz]
more...
Supported Version Ranges: v7.4.3 -> latest
- bandwidth Wi-fi channel bandwidth. type: str choices: [auto, 20MHz, 40MHz, 80MHz]
more...
Supported Version Ranges: v7.4.3 -> latest
- beacon_interval (Alias name: beacon-interval) Wi-fi beacon interval in miliseconds (100 - 3500, default = 100). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- bss_color (Alias name: bss-color) Wi-fi 802. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- bss_color_mode (Alias name: bss-color-mode) Wi-fi 802. type: str choices: [auto, static]
more...
Supported Version Ranges: v7.4.3 -> latest
- channel Wi-fi channels. type: list choices: [CH1, CH2, CH3, CH4, CH5, CH6, CH7, CH8, CH9, CH10, CH11]
more...
Supported Version Ranges: v7.4.3 -> latest
- extension_channel (Alias name: extension-channel) Wi-fi extension channel. type: str choices: [auto, higher, lower]
more...
Supported Version Ranges: v7.4.3 -> latest
- guard_interval (Alias name: guard-interval) Wi-fi guard interval. type: str choices: [auto, 400ns, 800ns]
more...
Supported Version Ranges: v7.4.3 -> latest
- lan_ext_vap (Alias name: lan-ext-vap) Wi-fi lan-extention vap. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- local_vaps (Alias name: local-vaps) Wi-fi local vap. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- max_clients (Alias name: max-clients) Maximum number of wi-fi radio clients (0 - 512, 0 = unlimited, default = 0). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- mode Wi-fi radio mode ap(lan mode) / client(wan mode). type: str choices: [AP, Client]
more...
Supported Version Ranges: v7.4.3 -> latest
- operating_standard (Alias name: operating-standard) Wi-fi operating standard. type: str choices: [auto, 11A-N-AC-AX, 11A-N-AC, 11A-N, 11A, 11N-AC-AX, 11AC-AX, 11AC, 11N-AC, 11B-G-N-AX, 11B-G-N, 11B-G, 11B, 11G-N-AX, 11N-AX, 11AX, 11G-N, 11N, 11G]
more...
Supported Version Ranges: v7.4.3 -> latest
- power_level (Alias name: power-level) Wi-fi power level in percent (0 - 100, 0 = auto, default = 100). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- radio_id (Alias name: radio-id) Radio id. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- status Enable/disable wi-fi radio. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- radio_2 (Alias name: radio-2) Radio 2. type: dict
more...
Supported Version Ranges: v7.4.3 -> latest
- d80211d (Alias name: 80211d) Enable/disable wi-fi 802. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- band Wi-fi band selection 2. type: str choices: [5GHz]
more...
Supported Version Ranges: v7.4.3 -> latest
- bandwidth Wi-fi channel bandwidth. type: str choices: [auto, 20MHz, 40MHz, 80MHz]
more...
Supported Version Ranges: v7.4.3 -> latest
- beacon_interval (Alias name: beacon-interval) Wi-fi beacon interval in miliseconds (100 - 3500, default = 100). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- bss_color (Alias name: bss-color) Wi-fi 802. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- bss_color_mode (Alias name: bss-color-mode) Wi-fi 802. type: str choices: [auto, static]
more...
Supported Version Ranges: v7.4.3 -> latest
- channel Wi-fi channels. type: list choices: [CH36, CH40, CH44, CH48, CH52, CH56, CH60, CH64, CH100, CH104, CH108, CH112, CH116, CH120, CH124, CH128, CH132, CH136, CH140, CH144, CH149, CH153, CH157, CH161, CH165]
more...
Supported Version Ranges: v7.4.3 -> latest
- extension_channel (Alias name: extension-channel) Wi-fi extension channel. type: str choices: [auto, higher, lower]
more...
Supported Version Ranges: v7.4.3 -> latest
- guard_interval (Alias name: guard-interval) Wi-fi guard interval. type: str choices: [auto, 400ns, 800ns]
more...
Supported Version Ranges: v7.4.3 -> latest
- lan_ext_vap (Alias name: lan-ext-vap) Wi-fi lan-extention vap. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- local_vaps (Alias name: local-vaps) Wi-fi local vap. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- max_clients (Alias name: max-clients) Maximum number of wi-fi radio clients (0 - 512, 0 = unlimited, default = 0). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- mode Wi-fi radio mode ap(lan mode) / client(wan mode). type: str choices: [AP, Client]
more...
Supported Version Ranges: v7.4.3 -> latest
- operating_standard (Alias name: operating-standard) Wi-fi operating standard. type: str choices: [auto, 11A-N-AC-AX, 11A-N-AC, 11A-N, 11A, 11N-AC-AX, 11AC-AX, 11AC, 11N-AC, 11B-G-N-AX, 11B-G-N, 11B-G, 11B, 11G-N-AX, 11N-AX, 11AX, 11G-N, 11N, 11G]
more...
Supported Version Ranges: v7.4.3 -> latest
- power_level (Alias name: power-level) Wi-fi power level in percent (0 - 100, 0 = auto, default = 100). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- radio_id (Alias name: radio-id) Radio id. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- status Enable/disable wi-fi radio. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> 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
tasks:
- name: FortiExtender extender profile configuration.
fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile:
# workspace_locking_adom:
adom:
state: present #
extensioncontroller_extenderprofile:
id: 0 # Required variable, integer
# allowaccess: ["https", "ping", "ssh", "snmp", "http", "telnet"]
# bandwidth_limit:
# cellular:
# controller_report:
# interval:
# signal_threshold:
# status:
# dataplan:
# modem1:
# auto_switch:
# dataplan:
# disconnect:
# disconnect_period:
# disconnect_threshold:
# signal:
# switch_back: ["time", "timer"]
# switch_back_time:
# switch_back_timer:
# conn_status:
# default_sim:
# gps:
# modem_id:
# preferred_carrier:
# redundant_intf:
# redundant_mode:
# sim1_pin:
# sim1_pin_code:
# sim2_pin:
# sim2_pin_code:
# multiple_PDN:
# pdn1_dataplan:
# pdn2_dataplan:
# pdn3_dataplan:
# pdn4_dataplan:
# modem2:
# auto_switch:
# dataplan:
# disconnect:
# disconnect_period:
# disconnect_threshold:
# signal:
# switch_back: ["time", "timer"]
# switch_back_time:
# switch_back_timer:
# conn_status:
# default_sim:
# gps:
# modem_id:
# preferred_carrier:
# redundant_intf:
# redundant_mode:
# sim1_pin:
# sim1_pin_code:
# sim2_pin:
# sim2_pin_code:
# multiple_PDN:
# pdn1_dataplan:
# pdn2_dataplan:
# pdn3_dataplan:
# pdn4_dataplan:
# sms_notification:
# alert:
# data_exhausted:
# fgt_backup_mode_switch:
# low_signal_strength:
# mode_switch:
# os_image_fallback:
# session_disconnect:
# system_reboot:
# receiver:
# - alert: ["system-reboot", "data-exhausted", "session-disconnect",
# "low-signal-strength", "mode-switch", "os-image-fallback",
# "fgt-backup-mode-switch"]
# name:
# phone_number:
# status:
# status:
# enforce_bandwidth:
# extension:
# lan_extension:
# backhaul:
# - name:
# port:
# role:
# weight:
# health_check_fail_cnt:
# health_check_interval:
# health_check_probe_cnt:
# health_check_probe_tm:
# health_check_recovery_cnt:
# backhaul_interface:
# backhaul_ip:
# ipsec_tunnel:
# link_loadbalance:
# downlinks:
# - name:
# port:
# pvid:
# type:
# vap:
# vids:
# traffic_split_services:
# - address:
# name:
# service:
# vsdb:
# login_password:
# login_password_change:
# model:
# name:
# _is_factory_setting:
# wifi:
# DFS:
# country:
# radio_1:
# d80211d:
# band:
# bandwidth:
# beacon_interval:
# bss_color:
# bss_color_mode:
# channel: ["CH1", "CH2", "CH3", "CH4", "CH5", "CH6", "CH7", "CH8", "CH9", "CH10",
# "CH11"]
# extension_channel:
# guard_interval:
# lan_ext_vap:
# local_vaps:
# max_clients:
# mode:
# operating_standard:
# power_level:
# radio_id:
# status:
# radio_2:
# d80211d:
# band:
# bandwidth:
# beacon_interval:
# bss_color:
# bss_color_mode:
# channel: ["CH36", "CH40", "CH44", "CH48", "CH52", "CH56", "CH60", "CH64", "CH100",
# "CH104", "CH108", "CH112", "CH116", "CH120", "CH124", "CH128", "CH132",
# "CH136", "CH140", "CH144", "CH149", "CH153", "CH157", "CH161", "CH165"]
# extension_channel:
# guard_interval:
# lan_ext_vap:
# local_vaps:
# max_clients:
# mode:
# operating_standard:
# power_level:
# radio_id:
# status:
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:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)