fmgr_extensioncontroller_extenderprofile_lanextension – FortiExtender lan extension configuration.
Added in version 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.nameNew 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.
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.1 -> 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
- 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
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- extender_profile - The parameter in requested url type: str required: true
- extensioncontroller_extenderprofile_lanextension - FortiExtender lan extension configuration. type: dict
- backhaul Backhaul. type: list
more...
- name Fortiextender lan extension backhaul name. type: str more...
- port Fortiextender uplink port. type: str choices: [wan, lte1, lte2, port1, port2, port3, port4, port5, sfp] more...
- role Fortiextender uplink port. type: str choices: [primary, secondary] more...
- weight Wrr weight parameter. type: int more...
- health_check_fail_cnt (Alias name: health-check-fail-cnt) Number of failures before the link is considered dead (1 - 10, default = 5). type: int more...
- health_check_interval (Alias name: health-check-interval) Health monitoring interval in seconds (1 - 3600, default = 5). type: int more...
- health_check_probe_cnt (Alias name: health-check-probe-cnt) Number of health monitoring probes to send within an interval (1 - 10, default = 1). type: int more...
- health_check_probe_tm (Alias name: health-check-probe-tm) Health monitoring probe timeout in seconds (1 - 10, default = 2). type: int more...
- health_check_recovery_cnt (Alias name: health-check-recovery-cnt) Number of successful checks before the link is considered alive (1 - 10, default = 5). type: int more...
- backhaul_interface (Alias name: backhaul-interface) Ipsec phase1 interface. type: str more...
- backhaul_ip (Alias name: backhaul-ip) Ipsec phase1 ipv4/fqdn. type: str more...
- ipsec_tunnel (Alias name: ipsec-tunnel) Ipsec tunnel name. type: str more...
- link_loadbalance (Alias name: link-loadbalance) Lan extension link load balance strategy. type: str choices: [activebackup, loadbalance] more...
- downlinks Downlinks. type: list
more...
- name Fortiextender lan extension downlink config entry name. type: str more...
- port Fortiextender lan extension downlink port. type: str choices: [port1, port2, port3, port4, port5, lan1, lan2, lan] more...
- pvid Fortiextender lan extension downlink pvid. type: int more...
- type Fortiextender lan extension downlink type [port/vap]. type: str choices: [port, vap] more...
- vap Fortiextender lan extension downlink vap. type: list more...
- vids Fortiextender lan extension downlink vids. type: list more...
- traffic_split_services (Alias name: traffic-split-services) Traffic split services. type: list 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
tasks:
- name: FortiExtender lan extension configuration.
fortinet.fortimanager.fmgr_extensioncontroller_extenderprofile_lanextension:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
extender_profile: <your own value>
extensioncontroller_extenderprofile_lanextension:
# backhaul:
# - name: <string>
# port: <value in [wan, lte1, lte2, ...]>
# role: <value in [primary, secondary]>
# weight: <integer>
# health_check_fail_cnt: <integer>
# health_check_interval: <integer>
# health_check_probe_cnt: <integer>
# health_check_probe_tm: <integer>
# health_check_recovery_cnt: <integer>
# backhaul_interface: <string>
# backhaul_ip: <string>
# ipsec_tunnel: <string>
# link_loadbalance: <value in [activebackup, loadbalance]>
# downlinks:
# - name: <string>
# port: <value in [port1, port2, port3, ...]>
# pvid: <integer>
# type: <value in [port, vap]>
# vap: <list or string>
# vids: <list or integer>
# traffic_split_services:
# - address: <list or string>
# name: <string>
# service: <list or string>
# vsdb: <value in [disable, enable]>
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.