fortios_extension_controller_extender – Extender controller configuration in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
Synopsis¶
- 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
Parameters¶
- 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...
- allowaccess - Control management access to the managed extender. Separate entries with a space. type: list choices: ping, telnet, http, https, ssh, snmp more...
- authorized - FortiExtender Administration (enable or disable). type: str choices: disable, enable more...
- bandwidth_limit - FortiExtender LAN extension bandwidth limit (Mbps). type: int more...
- description - Description. type: str more...
- device_id - Device ID. type: int more...
- enforce_bandwidth - Enable/disable enforcement of bandwidth on LAN extension interface. type: str choices: enable, disable more...
- ext_name - FortiExtender name. type: str more...
- extension_type - Extension type for this FortiExtender. type: str choices: wan-extension, lan-extension more...
- firmware_provision_latest - Enable/disable one-time automatic provisioning of the latest firmware version. type: str choices: disable, once more...
- id - FortiExtender serial number. type: str more...
- login_password - Set the managed extender"s administrator password. type: str more...
- login_password_change - Change or reset the administrator password of a managed extender (yes, default, or no). type: str choices: yes, default, no more...
- name - FortiExtender entry name. type: str required: true more...
- override_allowaccess - Enable to override the extender profile management access configuration. type: str choices: enable, disable more...
- override_enforce_bandwidth - Enable to override the extender profile enforce-bandwidth setting. type: str choices: enable, disable more...
- override_login_password_change - Enable to override the extender profile login-password (administrator password) setting. type: str choices: enable, disable more...
- profile - FortiExtender profile configuration. Source . type: str more...
- wan_extension - FortiExtender wan extension configuration. type: dict more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Extender controller configuration.
fortios_extension_controller_extender:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
extension_controller_extender:
allowaccess: "ping"
authorized: "disable"
bandwidth_limit: "1024"
description: "<your_own_value>"
device_id: "1024"
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 )"
wan_extension:
modem1_extension: "<your_own_value> (source )"
modem2_extension: "<your_own_value> (source )"
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:
- 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