fmgr_wtpprofile_lan – WTP LAN port mapping.¶
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
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| wtpprofile_lan | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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
- wtp-profile - The parameter in requested url type: str required: true
- wtpprofile_lan - no description type: dict
- port-mode - LAN port mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
- port-ssid - Bridge LAN port to SSID. type: str more...
- port1-mode - LAN port 1 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
- port1-ssid - Bridge LAN port 1 to SSID. type: str more...
- port2-mode - LAN port 2 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
- port2-ssid - Bridge LAN port 2 to SSID. type: str more...
- port3-mode - LAN port 3 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
- port3-ssid - Bridge LAN port 3 to SSID. type: str more...
- port4-mode - LAN port 4 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
- port4-ssid - Bridge LAN port 4 to SSID. type: str more...
- port5-mode - LAN port 5 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
- port5-ssid - Bridge LAN port 5 to SSID. type: str more...
- port6-mode - LAN port 6 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
- port6-ssid - Bridge LAN port 6 to SSID. type: str more...
- port7-mode - LAN port 7 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
- port7-ssid - Bridge LAN port 7 to SSID. type: str more...
- port8-mode - LAN port 8 mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
- port8-ssid - Bridge LAN port 8 to SSID. type: str more...
- port-esl-mode - ESL port mode. type: str choices: [offline, bridge-to-wan, bridge-to-ssid, nat-to-wan] more...
- port-esl-ssid - Bridge ESL port to SSID. 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¶
- 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_wtpprofile_lan:
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>
wtp-profile: <your own value>
wtpprofile_lan:
port-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port-ssid: <value of string>
port1-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port1-ssid: <value of string>
port2-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port2-ssid: <value of string>
port3-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port3-ssid: <value of string>
port4-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port4-ssid: <value of string>
port5-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port5-ssid: <value of string>
port6-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port6-ssid: <value of string>
port7-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port7-ssid: <value of string>
port8-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port8-ssid: <value of string>
port-esl-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port-esl-ssid: <value of 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:
- 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