fmgd_extendercontroller_extender – Device vdom extender controller extender.

Added in version 1.0.0.

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

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

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

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

- 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: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        extendercontroller_extender:
          id: "your value" # Required variable, string
          # _dataplan: <list or string>
          # _template: <list or string>
          # allowaccess:
          #   - "https"
          #   - "ping"
          #   - "ssh"
          #   - "snmp"
          #   - "http"
          #   - "telnet"
          # authorized: <value in [disable, enable]>
          # bandwidth_limit: <integer>
          # description: <string>
          # device_id: <integer>
          # enforce_bandwidth: <value in [disable, enable]>
          # ext_name: <string>
          # extension_type: <value in [wan-extension, lan-extension]>
          # login_password: <list or string>
          # login_password_change: <value in [no, yes, default]>
          # name: <string>
          # override_allowaccess: <value in [disable, enable]>
          # override_enforce_bandwidth: <value in [disable, enable]>
          # override_login_password_change: <value in [disable, enable]>
          # profile: <list or string>
          # vdom: <integer>
          # wan_extension:
          #   modem1_extension: <list or string>
          #   modem2_extension: <list or string>
          # modem1:
          #   _ifname: <list or string>
          #   _sim_profile: <list or string>
          #   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>
          #     status: <value in [disable, enable]>
          #   conn_status: <integer>
          #   default_sim: <value in [sim1, sim2, carrier, ...]>
          #   gps: <value in [disable, enable]>
          #   ifname: <list or string>
          #   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>
          #   status: <value in [disable, enable]>
          # modem2:
          #   _ifname: <list or string>
          #   _sim_profile: <list or string>
          #   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>
          #     status: <value in [disable, enable]>
          #   conn_status: <integer>
          #   default_sim: <value in [sim1, sim2, carrier, ...]>
          #   gps: <value in [disable, enable]>
          #   ifname: <list or string>
          #   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>
          #   status: <value in [disable, enable]>
          # controller_report:
          #   interval: <integer>
          #   signal_threshold: <integer>
          #   status: <value in [disable, enable]>
          # ppp_echo_request: <value in [disable, enable]>
          # ppp_username: <string>
          # initiated_update: <value in [disable, enable]>
          # cdma_aaa_spi: <string>
          # redial: <value in [none, 1, 2, ...]>
          # ha_shared_secret: <list or string>
          # ppp_auth_protocol: <value in [auto, pap, chap]>
          # secondary_ha: <string>
          # ppp_password: <list or string>
          # at_dial_script: <string>
          # ifname: <list or string>
          # cdma_nai: <string>
          # billing_start_day: <integer>
          # wimax_carrier: <string>
          # aaa_shared_secret: <list or string>
          # primary_ha: <string>
          # cdma_ha_spi: <string>
          # dial_status: <integer>
          # modem_passwd: <list or string>
          # roaming: <value in [disable, enable]>
          # dial_mode: <value in [dial-on-demand, always-connect]>
          # multi_mode: <value in [auto, auto-3g, force-lte, ...]>
          # mode: <value in [standalone, redundant]>
          # sim_pin: <list or string>
          # modem_type: <value in [cdma, gsm/lte, wimax]>
          # redundant_intf: <string>
          # role: <value in [none, primary, secondary]>
          # access_point_name: <string>
          # wimax_realm: <string>
          # wimax_auth_protocol: <value in [tls, ttls]>
          # quota_limit_mb: <integer>
          # admin: <value in [disable, enable, discovered]>
          # conn_status: <integer>
          # _prefer_img_ver: <string>

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:

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