: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 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)