Skip to content

Latest commit

 

History

History
518 lines (474 loc) · 23.1 KB

fortios_extension_controller_extender.rst

File metadata and controls

518 lines (474 loc) · 23.1 KB
source:fortios_extension_controller_extender.py
orphan:

fortios_extension_controller_extender -- Extender controller configuration in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extension_controller feature and extender category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Using member operation to add an element to an existing object.


Supported Version Ranges
fortios_extension_controller_extender v7.2.1 -> latest

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • extension_controller_extender - Extender controller configuration. type: dict more...
    Supported Version Ranges
    extension_controller_extender v7.2.1 -> latest
    • allowaccess - Control management access to the managed extender. Separate entries with a space. type: list choices: ping, telnet, http, https, ssh, snmp more...
      Supported Version Ranges
      allowaccess v7.2.1 -> latest
      [ping] v6.0.0 -> latest
      [telnet] v6.0.0 -> latest
      [http] v6.0.0 -> latest
      [https] v6.0.0 -> latest
      [ssh] v6.0.0 -> latest
      [snmp] v6.0.0 -> latest
    • authorized - FortiExtender Administration (enable or disable). type: str choices: discovered, disable, enable more...
      Supported Version Ranges
      authorized v7.2.1 -> latest
      [discovered] v7.2.4 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • bandwidth_limit - FortiExtender LAN extension bandwidth limit (Mbps). type: int more...
      Supported Version Ranges
      bandwidth_limit v7.2.1 -> latest
    • description - Description. type: str more...
      Supported Version Ranges
      description v7.2.1 -> latest
    • device_id - Device ID. type: int more...
      Supported Version Ranges
      device_id v7.2.1 -> latest
    • enforce_bandwidth - Enable/disable enforcement of bandwidth on LAN extension interface. type: str choices: enable, disable more...
      Supported Version Ranges
      enforce_bandwidth v7.2.1 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • ext_name - FortiExtender name. type: str more...
      Supported Version Ranges
      ext_name v7.2.1 -> latest
    • extension_type - Extension type for this FortiExtender. type: str choices: wan-extension, lan-extension more...
      Supported Version Ranges
      extension_type v7.2.1 -> latest
      [wan-extension] v6.0.0 -> latest
      [lan-extension] v6.0.0 -> latest
    • firmware_provision_latest - Enable/disable one-time automatic provisioning of the latest firmware version. type: str choices: disable, once more...
      Supported Version Ranges
      firmware_provision_latest v7.2.1 -> latest
      [disable] v6.0.0 -> latest
      [once] v6.0.0 -> latest
    • id - FortiExtender serial number. type: str more...
      Supported Version Ranges
      id v7.2.1 -> latest
    • login_password - Set the managed extender"s administrator password. type: str more...
      Supported Version Ranges
      login_password v7.2.1 -> latest
    • login_password_change - Change or reset the administrator password of a managed extender (yes, default, or no). type: str choices: yes, default, no more...
      Supported Version Ranges
      login_password_change v7.2.1 -> latest
      [yes] v6.0.0 -> latest
      [default] v6.0.0 -> latest
      [no] v6.0.0 -> latest
    • name - FortiExtender entry name. type: str required: true more...
      Supported Version Ranges
      name v7.2.1 -> latest
    • override_allowaccess - Enable to override the extender profile management access configuration. type: str choices: enable, disable more...
      Supported Version Ranges
      override_allowaccess v7.2.1 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • override_enforce_bandwidth - Enable to override the extender profile enforce-bandwidth setting. type: str choices: enable, disable more...
      Supported Version Ranges
      override_enforce_bandwidth v7.2.1 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • override_login_password_change - Enable to override the extender profile login-password (administrator password) setting. type: str choices: enable, disable more...
      Supported Version Ranges
      override_login_password_change v7.2.1 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • profile - FortiExtender profile configuration. Source extension-controller.extender-profile.name. type: str more...
      Supported Version Ranges
      profile v7.2.1 -> latest
    • wan_extension - FortiExtender wan extension configuration. type: dict more...
      Supported Version Ranges
      wan_extension v7.2.1 -> latest
      • modem1_extension - FortiExtender interface name. Source system.interface.name. type: str more...
        Supported Version Ranges
        modem1_extension v7.2.1 -> latest
      • modem2_extension - FortiExtender interface name. Source system.interface.name. type: str more...
        Supported Version Ranges
        modem2_extension v7.2.1 -> latest

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Extender controller configuration.
  fortinet.fortios.fortios_extension_controller_extender:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extension_controller_extender:
          allowaccess: "ping"
          authorized: "discovered"
          bandwidth_limit: "1024"
          description: "<your_own_value>"
          device_id: "128"
          enforce_bandwidth: "enable"
          ext_name: "<your_own_value>"
          extension_type: "wan-extension"
          firmware_provision_latest: "disable"
          id: "12"
          login_password: "<your_own_value>"
          login_password_change: "yes"
          name: "default_name_15"
          override_allowaccess: "enable"
          override_enforce_bandwidth: "enable"
          override_login_password_change: "enable"
          profile: "<your_own_value> (source extension-controller.extender-profile.name)"
          wan_extension:
              modem1_extension: "<your_own_value> (source system.interface.name)"
              modem2_extension: "<your_own_value> (source system.interface.name)"

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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3
  • This module is not guaranteed to have a backwards compatible interface.
  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.