drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_extendercontroller_extenderprofile FortiExtender extender profile configuration. | "added in version" 2.1.6 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_extendercontroller_extenderprofile (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- hosts: fortimanager-inventory collections: - fortinet.fortimanager connection: httpapi vars: ansible_httpapi_use_ssl: True ansible_httpapi_validate_certs: False ansible_httpapi_port: 443 tasks: - name: FortiExtender extender profile configuration. fmgr_extendercontroller_extenderprofile: bypass_validation: False workspace_locking_adom: <value in [global, custom adom including root]> workspace_locking_timeout: 300 rc_succeeded: [0, -2, -3, ...] rc_failed: [-2, -3, ...] adom: <your own value> state: <value in [present, absent]> extendercontroller_extenderprofile: allowaccess: - https - ping - ssh - snmp - http - telnet bandwidth-limit: <value of integer> cellular: controller-report: interval: <value of integer> signal-threshold: <value of integer> status: <value in [disable, enable]> dataplan: <value of string> modem1: auto-switch: dataplan: <value in [disable, enable]> disconnect: <value in [disable, enable]> disconnect-period: <value of integer> disconnect-threshold: <value of integer> signal: <value in [disable, enable]> switch-back: - time - timer switch-back-time: <value of string> switch-back-timer: <value of integer> conn-status: <value of integer> default-sim: <value in [sim1, sim2, carrier, ...]> gps: <value in [disable, enable]> modem-id: <value of integer> preferred-carrier: <value of string> redundant-intf: <value of string> redundant-mode: <value in [disable, enable]> sim1-pin: <value in [disable, enable]> sim1-pin-code: <value of string> sim2-pin: <value in [disable, enable]> sim2-pin-code: <value of string> modem2: auto-switch: dataplan: <value in [disable, enable]> disconnect: <value in [disable, enable]> disconnect-period: <value of integer> disconnect-threshold: <value of integer> signal: <value in [disable, enable]> switch-back: - time - timer switch-back-time: <value of string> switch-back-timer: <value of integer> conn-status: <value of integer> default-sim: <value in [sim1, sim2, carrier, ...]> gps: <value in [disable, enable]> modem-id: <value of integer> preferred-carrier: <value of string> redundant-intf: <value of string> redundant-mode: <value in [disable, enable]> sim1-pin: <value in [disable, enable]> sim1-pin-code: <value of string> sim2-pin: <value in [disable, enable]> sim2-pin-code: <value of string> sms-notification: alert: data-exhausted: <value of string> fgt-backup-mode-switch: <value of string> low-signal-strength: <value of string> mode-switch: <value of string> os-image-fallback: <value of string> session-disconnect: <value of string> system-reboot: <value of string> receiver: - alert: - system-reboot - data-exhausted - session-disconnect - low-signal-strength - mode-switch - os-image-fallback - fgt-backup-mode-switch name: <value of string> phone-number: <value of string> status: <value in [disable, enable]> status: <value in [disable, enable]> enforce-bandwidth: <value in [disable, enable]> extension: <value in [wan-extension, lan-extension]> id: <value of integer> lan-extension: backhaul: - name: <value of string> port: <value in [wan, lte1, lte2, ...]> role: <value in [primary, secondary]> weight: <value of integer> backhaul-interface: <value of string> backhaul-ip: <value of string> ipsec-tunnel: <value of string> link-loadbalance: <value in [activebackup, loadbalance]> login-password: <value of string> login-password-change: <value in [no, yes, default]> model: <value in [FX201E, FX211E, FX200F, ...]> name: <value of string>
adom: description: the parameter (adom) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int extendercontroller_extenderprofile: description: the top level parameters set required: false suboptions: allowaccess: choices: - https - ping - ssh - snmp - http - telnet description: description elements: str type: list bandwidth-limit: description: FortiExtender LAN extension bandwidth limit type: int cellular: description: no description required: false suboptions: controller-report: description: no description required: false suboptions: interval: description: Controller report interval. type: int signal-threshold: description: Controller report signal threshold. type: int status: choices: - disable - enable description: FortiExtender controller report status. type: str type: dict dataplan: description: description type: str modem1: description: no description required: false suboptions: auto-switch: description: no description required: false suboptions: dataplan: choices: - disable - enable description: Automatically switch based on data usage. type: str disconnect: choices: - disable - enable description: Auto switch by disconnect. type: str disconnect-period: description: Automatically switch based on disconnect period. type: int disconnect-threshold: description: Automatically switch based on disconnect threshold. type: int signal: choices: - disable - enable description: Automatically switch based on signal strength. type: str switch-back: choices: - time - timer description: description elements: str type: list switch-back-time: description: Automatically switch over to preferred SIM/carrier at a specified time in UTC type: str switch-back-timer: description: Automatically switch over to preferred SIM/carrier after the given time type: int type: dict conn-status: description: no description type: int default-sim: choices: - sim1 - sim2 - carrier - cost description: Default SIM selection. type: str gps: choices: - disable - enable description: FortiExtender GPS enable/disable. type: str modem-id: description: Modem ID. type: int preferred-carrier: description: Preferred carrier. type: str redundant-intf: description: Redundant interface. type: str redundant-mode: choices: - disable - enable description: FortiExtender mode. type: str sim1-pin: choices: - disable - enable description: SIM type: str sim1-pin-code: description: description type: str sim2-pin: choices: - disable - enable description: SIM type: str sim2-pin-code: description: description type: str type: dict modem2: description: no description required: false suboptions: auto-switch: description: no description required: false suboptions: dataplan: choices: - disable - enable description: Automatically switch based on data usage. type: str disconnect: choices: - disable - enable description: Auto switch by disconnect. type: str disconnect-period: description: Automatically switch based on disconnect period. type: int disconnect-threshold: description: Automatically switch based on disconnect threshold. type: int signal: choices: - disable - enable description: Automatically switch based on signal strength. type: str switch-back: choices: - time - timer description: description elements: str type: list switch-back-time: description: Automatically switch over to preferred SIM/carrier at a specified time in UTC type: str switch-back-timer: description: Automatically switch over to preferred SIM/carrier after the given time type: int type: dict conn-status: description: no description type: int default-sim: choices: - sim1 - sim2 - carrier - cost description: Default SIM selection. type: str gps: choices: - disable - enable description: FortiExtender GPS enable/disable. type: str modem-id: description: Modem ID. type: int preferred-carrier: description: Preferred carrier. type: str redundant-intf: description: Redundant interface. type: str redundant-mode: choices: - disable - enable description: FortiExtender mode. type: str sim1-pin: choices: - disable - enable description: SIM type: str sim1-pin-code: description: description type: str sim2-pin: choices: - disable - enable description: SIM type: str sim2-pin-code: description: description type: str type: dict sms-notification: description: no description required: false suboptions: alert: description: no description required: false suboptions: data-exhausted: description: Display string when data exhausted. type: str fgt-backup-mode-switch: description: Display string when FortiGate backup mode switched. type: str low-signal-strength: description: Display string when signal strength is low. type: str mode-switch: description: Display string when mode is switched. type: str os-image-fallback: description: Display string when falling back to a previous OS image. type: str session-disconnect: description: Display string when session disconnected. type: str system-reboot: description: Display string when system rebooted. type: str type: dict receiver: description: description elements: dict suboptions: alert: choices: - system-reboot - data-exhausted - session-disconnect - low-signal-strength - mode-switch - os-image-fallback - fgt-backup-mode-switch description: description elements: str type: list name: description: FortiExtender SMS notification receiver name. type: str phone-number: description: Receiver phone number. type: str status: choices: - disable - enable description: SMS notification receiver status. type: str type: list status: choices: - disable - enable description: FortiExtender SMS notification status. type: str type: dict type: dict enforce-bandwidth: choices: - disable - enable description: Enable/disable enforcement of bandwidth on LAN extension interface. type: str extension: choices: - wan-extension - lan-extension description: Extension option. type: str id: description: ID. type: int lan-extension: description: no description required: false suboptions: backhaul: description: description elements: dict suboptions: name: description: FortiExtender LAN extension backhaul name. type: str port: choices: - wan - lte1 - lte2 - port1 - port2 - port3 - port4 - port5 - sfp description: FortiExtender uplink port. type: str role: choices: - primary - secondary description: FortiExtender uplink port. type: str weight: description: WRR weight parameter. type: int type: list backhaul-interface: description: IPsec phase1 interface. type: str backhaul-ip: description: IPsec phase1 IPv4/FQDN. type: str ipsec-tunnel: description: IPsec tunnel name. type: str link-loadbalance: choices: - activebackup - loadbalance description: LAN extension link load balance strategy. type: str type: dict login-password: description: description type: str login-password-change: choices: - 'no' - 'yes' - default description: Change or reset the administrator password of a managed extender type: str model: choices: - FX201E - FX211E - FX200F - FXA11F - FXE11F - FXA21F - FXE21F - FXA22F - FXE22F - FX212F - FX311F - FX312F - FX511F - FVG21F - FVA21F - FVG22F - FVA22F - FX04DA - FX04DN - FX04DI description: Model. type: str name: description: FortiExtender profile name. type: str type: dict
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list