:source: fmgd_extendercontroller_extender.py
:orphan:
.. _fmgd_extendercontroller_extender:
fmgd_extendercontroller_extender -- Device vdom extender controller extender.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. 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
- vdom - The parameter in requested url type: str required: true
- extendercontroller_extender - Device vdom extender controller extender type: dict
- _dataplan Dataplan. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- _template Template. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- allowaccess Control management access to the managed extender. type: list choices: [https, ping, ssh, snmp, http, telnet]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- authorized Fortiextender administration (enable or disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- bandwidth_limit (Alias name: bandwidth-limit) Fortiextender lan extension bandwidth limit (mbps). type: int
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
- device_id (Alias name: device-id) Device id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> 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.6 -> v7.2.12, v7.4.3 -> latest
- ext_name (Alias name: ext-name) Fortiextender name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- extension_type (Alias name: extension-type) Extension type for this fortiextender. type: str choices: [wan-extension, lan-extension]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Fortiextender serial number. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- login_password (Alias name: login-password) Set the managed extenders administrator password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> 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.6 -> v7.2.12, v7.4.3 -> latest
- name Fortiextender entry name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_allowaccess (Alias name: override-allowaccess) Enable to override the extender profile management access configuration. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_enforce_bandwidth (Alias name: override-enforce-bandwidth) Enable to override the extender profile enforce-bandwidth setting. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- override_login_password_change (Alias name: override-login-password-change) Enable to override the extender profile login-password (administrator password) setting. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- profile Fortiextender profile configuration. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vdom Vdom. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wan_extension (Alias name: wan-extension) Wan extension. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- modem1_extension (Alias name: modem1-extension) Fortiextender interface name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- modem2_extension (Alias name: modem2-extension) Fortiextender interface name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- modem1 Modem1. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- _ifname Support meta variable type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- _sim_profile Support meta variable type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- auto_switch (Alias name: auto-switch) Auto switch. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dataplan Automatically switch based on data usage. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- disconnect Auto switch by disconnect. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- disconnect_period (Alias name: disconnect-period) Automatically switch based on disconnect period. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- disconnect_threshold (Alias name: disconnect-threshold) Automatically switch based on disconnect threshold. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- signal Automatically switch based on signal strength. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> 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.6 -> v7.2.12, v7.4.3 -> 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.6 -> v7.2.12, v7.4.3 -> 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.6 -> v7.2.12, v7.4.3 -> latest
- status Fortiextender automatic switch status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- conn_status (Alias name: conn-status) Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- default_sim (Alias name: default-sim) Default sim selection. type: str choices: [sim1, sim2, carrier, cost]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- gps Fortiextender gps enable/disable. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ifname Fortiextender interface name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- modem_id (Alias name: modem-id) Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- preferred_carrier (Alias name: preferred-carrier) Preferred carrier. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- redundant_intf (Alias name: redundant-intf) Redundant interface. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- redundant_mode (Alias name: redundant-mode) Fortiextender mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sim1_pin (Alias name: sim1-pin) Sim #1 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sim1_pin_code (Alias name: sim1-pin-code) Sim #1 pin password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sim2_pin (Alias name: sim2-pin) Sim #2 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sim2_pin_code (Alias name: sim2-pin-code) Sim #2 pin password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- status Fortiextender modem status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- modem2 Modem2. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- _ifname Support meta variable type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- _sim_profile Support meta variable type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- auto_switch (Alias name: auto-switch) Auto switch. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dataplan Automatically switch based on data usage. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- disconnect Auto switch by disconnect. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- disconnect_period (Alias name: disconnect-period) Automatically switch based on disconnect period. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- disconnect_threshold (Alias name: disconnect-threshold) Automatically switch based on disconnect threshold. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- signal Automatically switch based on signal strength. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> 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.6 -> v7.2.12, v7.4.3 -> 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.6 -> v7.2.12, v7.4.3 -> 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.6 -> v7.2.12, v7.4.3 -> latest
- status Fortiextender automatic switch status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- conn_status (Alias name: conn-status) Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- default_sim (Alias name: default-sim) Default sim selection. type: str choices: [sim1, sim2, carrier, cost]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- gps Fortiextender gps enable/disable. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ifname Fortiextender interface name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- modem_id (Alias name: modem-id) Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- preferred_carrier (Alias name: preferred-carrier) Preferred carrier. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- redundant_intf (Alias name: redundant-intf) Redundant interface. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- redundant_mode (Alias name: redundant-mode) Fortiextender mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sim1_pin (Alias name: sim1-pin) Sim #1 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sim1_pin_code (Alias name: sim1-pin-code) Sim #1 pin password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sim2_pin (Alias name: sim2-pin) Sim #2 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sim2_pin_code (Alias name: sim2-pin-code) Sim #2 pin password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- status Fortiextender modem status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- controller_report (Alias name: controller-report) Controller report. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- interval Controller report interval. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- signal_threshold (Alias name: signal-threshold) Controller report signal threshold. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- status Fortiextender controller report status. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ppp_echo_request (Alias name: ppp-echo-request) Enable/disable ppp echo request. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ppp_username (Alias name: ppp-username) Ppp username. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- initiated_update (Alias name: initiated-update) Allow/disallow network initiated updates to the modem. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cdma_aaa_spi (Alias name: cdma-aaa-spi) Cdma aaa spi. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- redial Number of redials allowed based on failed attempts. type: str choices: [none, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ha_shared_secret (Alias name: ha-shared-secret) Ha shared secret. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ppp_auth_protocol (Alias name: ppp-auth-protocol) Ppp authentication protocol (pap,chap or auto). type: str choices: [auto, pap, chap]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- secondary_ha (Alias name: secondary-ha) Secondary ha. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ppp_password (Alias name: ppp-password) Ppp password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- at_dial_script (Alias name: at-dial-script) Initialization at commands specific to the modem. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ifname Fortiextender interface name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cdma_nai (Alias name: cdma-nai) Nai for cdma modems. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- billing_start_day (Alias name: billing-start-day) Billing start day. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wimax_carrier (Alias name: wimax-carrier) Wimax carrier. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- aaa_shared_secret (Alias name: aaa-shared-secret) Aaa shared secret. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- primary_ha (Alias name: primary-ha) Primary ha. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cdma_ha_spi (Alias name: cdma-ha-spi) Cdma ha spi. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dial_status (Alias name: dial-status) Dial status. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- modem_passwd (Alias name: modem-passwd) Modem password. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- roaming Enable/disable modem roaming. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dial_mode (Alias name: dial-mode) Dial mode (dial-on-demand or always-connect). type: str choices: [dial-on-demand, always-connect]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- multi_mode (Alias name: multi-mode) Modem mode of operation(3g,lte,etc). type: str choices: [auto, auto-3g, force-lte, force-3g, force-2g]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Fortiextender mode. type: str choices: [standalone, redundant]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sim_pin (Alias name: sim-pin) Sim pin. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- modem_type (Alias name: modem-type) Modem type (cdma, gsm/lte or wimax). type: str choices: [cdma, gsm/lte, wimax]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- redundant_intf (Alias name: redundant-intf) Redundant interface. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- role Fortiextender work role(primary, secondary, none). type: str choices: [none, primary, secondary]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- access_point_name (Alias name: access-point-name) Access point name(apn). type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wimax_realm (Alias name: wimax-realm) Wimax realm. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- wimax_auth_protocol (Alias name: wimax-auth-protocol) Wimax authentication protocol(tls or ttls). type: str choices: [tls, ttls]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- quota_limit_mb (Alias name: quota-limit-mb) Monthly quota limit (mb). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- admin Fortiextender administration (enable or disable). type: str choices: [disable, enable, discovered]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- conn_status (Alias name: conn-status) Conn status. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- _prefer_img_ver (Alias name: _prefer-img-ver) Prefer img ver. type: str
more...
Supported Version Ranges: v7.4.8 -> v7.4.10
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: Device vdom extender controller extender
fortinet.fmgdevice.fmgd_extendercontroller_extender:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
state: present #
extendercontroller_extender:
id: "your value" # Required variable, string
# _dataplan:
# _template:
# allowaccess:
# - "https"
# - "ping"
# - "ssh"
# - "snmp"
# - "http"
# - "telnet"
# authorized:
# bandwidth_limit:
# description:
# device_id:
# enforce_bandwidth:
# ext_name:
# extension_type:
# login_password:
# login_password_change:
# name:
# override_allowaccess:
# override_enforce_bandwidth:
# override_login_password_change:
# profile:
# vdom:
# wan_extension:
# modem1_extension:
# modem2_extension:
# modem1:
# _ifname:
# _sim_profile:
# auto_switch:
# dataplan:
# disconnect:
# disconnect_period:
# disconnect_threshold:
# signal:
# switch_back:
# - "time"
# - "timer"
# switch_back_time:
# switch_back_timer:
# status:
# conn_status:
# default_sim:
# gps:
# ifname:
# modem_id:
# preferred_carrier:
# redundant_intf:
# redundant_mode:
# sim1_pin:
# sim1_pin_code:
# sim2_pin:
# sim2_pin_code:
# status:
# modem2:
# _ifname:
# _sim_profile:
# auto_switch:
# dataplan:
# disconnect:
# disconnect_period:
# disconnect_threshold:
# signal:
# switch_back:
# - "time"
# - "timer"
# switch_back_time:
# switch_back_timer:
# status:
# conn_status:
# default_sim:
# gps:
# ifname:
# modem_id:
# preferred_carrier:
# redundant_intf:
# redundant_mode:
# sim1_pin:
# sim1_pin_code:
# sim2_pin:
# sim2_pin_code:
# status:
# controller_report:
# interval:
# signal_threshold:
# status:
# ppp_echo_request:
# ppp_username:
# initiated_update:
# cdma_aaa_spi:
# redial:
# ha_shared_secret:
# ppp_auth_protocol:
# secondary_ha:
# ppp_password:
# at_dial_script:
# ifname:
# cdma_nai:
# billing_start_day:
# wimax_carrier:
# aaa_shared_secret:
# primary_ha:
# cdma_ha_spi:
# dial_status:
# modem_passwd:
# roaming:
# dial_mode:
# multi_mode:
# mode:
# sim_pin:
# modem_type:
# redundant_intf:
# role:
# access_point_name:
# wimax_realm:
# wimax_auth_protocol:
# quota_limit_mb:
# admin:
# conn_status:
# _prefer_img_ver:
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)