- source
fmgr_extendercontroller_extenderprofile.py
- orphan
2.1.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.
- 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 v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v7.0.2 -> latest
- 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
- adom - The parameter in requested url type: str required: true
- extendercontroller_extenderprofile - FortiExtender extender profile configuration. type: dict
- allowaccess type: list choices: [https, ping, ssh, snmp, http, telnet]
more...
Supported Version Ranges:
v7.0.2 -> latest
- bandwidth_limit (Alias name: bandwidth-limit) Fortiextender lan extension bandwidth limit (mbps). type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- cellular type: dict
- controller_report (Alias name: controller-report) type: dict
- interval Controller report interval. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- signal_threshold (Alias name: signal-threshold) Controller report signal threshold. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- status Fortiextender controller report status. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- interval Controller report interval. type: int
more...
- dataplan type: list or str
more...
Supported Version Ranges:
v7.0.2 -> latest
- modem1 type: dict
- auto_switch (Alias name: auto-switch) type: dict
- dataplan Automatically switch based on data usage. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- disconnect Auto switch by disconnect. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- disconnect_period (Alias name: disconnect-period) Automatically switch based on disconnect period. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- disconnect_threshold (Alias name: disconnect-threshold) Automatically switch based on disconnect threshold. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- signal Automatically switch based on signal strength. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- switch_back (Alias name: switch-back) type: list choices: [time, timer]
more...
Supported Version Ranges:
v7.0.2 -> 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.0.2 -> 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.0.2 -> latest
- dataplan Automatically switch based on data usage. type: str choices: [disable, enable]
more...
- conn_status (Alias name: conn-status) type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- default_sim (Alias name: default-sim) Default sim selection. type: str choices: [sim1, sim2, carrier, cost]
more...
Supported Version Ranges:
v7.0.2 -> latest
- gps Fortiextender gps enable/disable. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- modem_id (Alias name: modem-id) Modem id. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- preferred_carrier (Alias name: preferred-carrier) Preferred carrier. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- redundant_intf (Alias name: redundant-intf) Redundant interface. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- redundant_mode (Alias name: redundant-mode) Fortiextender mode. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- sim1_pin (Alias name: sim1-pin) Sim #1 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- sim1_pin_code (Alias name: sim1-pin-code) type: list
more...
Supported Version Ranges:
v7.0.2 -> latest
- sim2_pin (Alias name: sim2-pin) Sim #2 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- sim2_pin_code (Alias name: sim2-pin-code) type: list
more...
Supported Version Ranges:
v7.0.2 -> latest
- auto_switch (Alias name: auto-switch) type: dict
- modem2 type: dict
- auto_switch (Alias name: auto-switch) type: dict
- dataplan Automatically switch based on data usage. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- disconnect Auto switch by disconnect. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- disconnect_period (Alias name: disconnect-period) Automatically switch based on disconnect period. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- disconnect_threshold (Alias name: disconnect-threshold) Automatically switch based on disconnect threshold. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- signal Automatically switch based on signal strength. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- switch_back (Alias name: switch-back) type: list choices: [time, timer]
more...
Supported Version Ranges:
v7.0.2 -> 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.0.2 -> 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.0.2 -> latest
- dataplan Automatically switch based on data usage. type: str choices: [disable, enable]
more...
- conn_status (Alias name: conn-status) type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- default_sim (Alias name: default-sim) Default sim selection. type: str choices: [sim1, sim2, carrier, cost]
more...
Supported Version Ranges:
v7.0.2 -> latest
- gps Fortiextender gps enable/disable. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- modem_id (Alias name: modem-id) Modem id. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- preferred_carrier (Alias name: preferred-carrier) Preferred carrier. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- redundant_intf (Alias name: redundant-intf) Redundant interface. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- redundant_mode (Alias name: redundant-mode) Fortiextender mode. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- sim1_pin (Alias name: sim1-pin) Sim #1 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- sim1_pin_code (Alias name: sim1-pin-code) type: list
more...
Supported Version Ranges:
v7.0.2 -> latest
- sim2_pin (Alias name: sim2-pin) Sim #2 pin status. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- sim2_pin_code (Alias name: sim2-pin-code) type: list
more...
Supported Version Ranges:
v7.0.2 -> latest
- auto_switch (Alias name: auto-switch) type: dict
- sms_notification (Alias name: sms-notification) type: dict
- alert type: dict
- data_exhausted (Alias name: data-exhausted) Display string when data exhausted. type: str
more...
Supported Version Ranges:
v7.0.2 -> 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.0.2 -> latest
- low_signal_strength (Alias name: low-signal-strength) Display string when signal strength is low. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- mode_switch (Alias name: mode-switch) Display string when mode is switched. type: str
more...
Supported Version Ranges:
v7.0.2 -> 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.0.2 -> latest
- session_disconnect (Alias name: session-disconnect) Display string when session disconnected. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- system_reboot (Alias name: system-reboot) Display string when system rebooted. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- data_exhausted (Alias name: data-exhausted) Display string when data exhausted. type: str
more...
- receiver type: list
more...
Supported Version Ranges:
v7.0.2 -> latest
- alert 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.0.2 -> latest
- name Fortiextender sms notification receiver name. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- phone_number (Alias name: phone-number) Receiver phone number. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- status Sms notification receiver status. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- alert type: list choices: [system-reboot, data-exhausted, session-disconnect, low-signal-strength, mode-switch, os-image-fallback, fgt-backup-mode-switch]
more...
- status Fortiextender sms notification status. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.0.2 -> latest
- alert type: dict
- controller_report (Alias name: controller-report) type: dict
- 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.0.2 -> latest
- extension Extension option. type: str choices: [wan-extension, lan-extension]
more...
Supported Version Ranges:
v7.0.2 -> latest
- id Id. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- lan_extension (Alias name: lan-extension) type: dict
- backhaul type: list
more...
Supported Version Ranges:
v7.0.2 -> latest
- name Fortiextender lan extension backhaul name. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- port Fortiextender uplink port. type: str choices: [wan, lte1, lte2, port1, port2, port3, port4, port5, sfp]
more...
Supported Version Ranges:
v7.0.2 -> latest
- role Fortiextender uplink port. type: str choices: [primary, secondary]
more...
Supported Version Ranges:
v7.0.2 -> latest
- weight Wrr weight parameter. type: int
more...
Supported Version Ranges:
v7.0.2 -> latest
- name Fortiextender lan extension backhaul name. type: str
more...
- backhaul_interface (Alias name: backhaul-interface) Ipsec phase1 interface. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- backhaul_ip (Alias name: backhaul-ip) Ipsec phase1 ipv4/fqdn. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- ipsec_tunnel (Alias name: ipsec-tunnel) Ipsec tunnel name. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
- link_loadbalance (Alias name: link-loadbalance) Lan extension link load balance strategy. type: str choices: [activebackup, loadbalance]
more...
Supported Version Ranges:
v7.0.2 -> latest
- backhaul type: list
more...
- login_password (Alias name: login-password) type: list
more...
Supported Version Ranges:
v7.0.2 -> 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.0.2 -> 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]
more...
Supported Version Ranges:
v7.0.2 -> latest
- name Fortiextender profile name. type: str
more...
Supported Version Ranges:
v7.0.2 -> latest
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: FortiExtender extender profile configuration.
fortinet.fortimanager.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: present # <value in [present, absent]>
extendercontroller_extenderprofile:
allowaccess:
- https
- ping
- ssh
- snmp
- http
- telnet
bandwidth_limit: <integer>
cellular:
controller_report:
interval: <integer>
signal_threshold: <integer>
status: <value in [disable, enable]>
dataplan: <list or string>
modem1:
auto_switch:
dataplan: <value in [disable, enable]>
disconnect: <value in [disable, enable]>
disconnect_period: <integer>
disconnect_threshold: <integer>
signal: <value in [disable, enable]>
switch_back:
- time
- timer
switch_back_time: <string>
switch_back_timer: <integer>
conn_status: <integer>
default_sim: <value in [sim1, sim2, carrier, ...]>
gps: <value in [disable, enable]>
modem_id: <integer>
preferred_carrier: <string>
redundant_intf: <string>
redundant_mode: <value in [disable, enable]>
sim1_pin: <value in [disable, enable]>
sim1_pin_code: <list or string>
sim2_pin: <value in [disable, enable]>
sim2_pin_code: <list or string>
modem2:
auto_switch:
dataplan: <value in [disable, enable]>
disconnect: <value in [disable, enable]>
disconnect_period: <integer>
disconnect_threshold: <integer>
signal: <value in [disable, enable]>
switch_back:
- time
- timer
switch_back_time: <string>
switch_back_timer: <integer>
conn_status: <integer>
default_sim: <value in [sim1, sim2, carrier, ...]>
gps: <value in [disable, enable]>
modem_id: <integer>
preferred_carrier: <string>
redundant_intf: <string>
redundant_mode: <value in [disable, enable]>
sim1_pin: <value in [disable, enable]>
sim1_pin_code: <list or string>
sim2_pin: <value in [disable, enable]>
sim2_pin_code: <list or string>
sms_notification:
alert:
data_exhausted: <string>
fgt_backup_mode_switch: <string>
low_signal_strength: <string>
mode_switch: <string>
os_image_fallback: <string>
session_disconnect: <string>
system_reboot: <string>
receiver:
-
alert:
- system-reboot
- data-exhausted
- session-disconnect
- low-signal-strength
- mode-switch
- os-image-fallback
- fgt-backup-mode-switch
name: <string>
phone_number: <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: <integer>
lan_extension:
backhaul:
-
name: <string>
port: <value in [wan, lte1, lte2, ...]>
role: <value in [primary, secondary]>
weight: <integer>
backhaul_interface: <string>
backhaul_ip: <string>
ipsec_tunnel: <string>
link_loadbalance: <value in [activebackup, loadbalance]>
login_password: <list or string>
login_password_change: <value in [no, yes, default]>
model: <value in [FX201E, FX211E, FX200F, ...]>
name: <string>
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:
- 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
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)