fmgr_extendercontroller_extenderprofile_lanextension – FortiExtender lan extension configuration.¶
New in version 2.10.
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- extender-profile - The parameter in requested url type: str required: true
- extendercontroller_extenderprofile_lanextension - no description type: dict
- backhaul - No description for the parameter type: array
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...
- backhaul-interface - IPsec phase1 interface. type: str more...
- backhaul-ip - IPsec phase1 IPv4/FQDN. type: str more...
- ipsec-tunnel - IPsec tunnel name. type: str more...
- link-loadbalance - LAN extension link load balance strategy. type: str choices: [activebackup, loadbalance] 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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
fmgr_extendercontroller_extenderprofile_lanextension:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
extender-profile: <your own value>
extendercontroller_extenderprofile_lanextension:
backhaul:
-
name: <value of string>
port: <value in [wan, lte1, lte2, ...]>
role: <value in [primary, secondary]>
weight: <value of integer>
backhaul-interface: <value of string>
backhaul-ip: <value of string>
ipsec-tunnel: <value of string>
link-loadbalance: <value in [activebackup, loadbalance]>
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict