fortinet.fortimanager.fmgr_wtpprofile_lan module – WTP LAN port mapping.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_wtpprofile_lan
.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
|
Deprecated, please use “wtp_profile” |
|
The parameter (wtp-profile) in requested url. |
|
The top level parameters set. |
|
Deprecated, please rename it to port_esl_mode. ESL port mode. Choices:
|
|
Deprecated, please rename it to port_esl_ssid. Bridge ESL port to SSID. |
|
Deprecated, please rename it to port_mode. LAN port mode. Choices:
|
|
Deprecated, please rename it to port_ssid. Bridge LAN port to SSID. |
|
Deprecated, please rename it to port1_mode. LAN port 1 mode. Choices:
|
|
Deprecated, please rename it to port1_ssid. Bridge LAN port 1 to SSID. |
|
Deprecated, please rename it to port2_mode. LAN port 2 mode. Choices:
|
|
Deprecated, please rename it to port2_ssid. Bridge LAN port 2 to SSID. |
|
Deprecated, please rename it to port3_mode. LAN port 3 mode. Choices:
|
|
Deprecated, please rename it to port3_ssid. Bridge LAN port 3 to SSID. |
|
Deprecated, please rename it to port4_mode. LAN port 4 mode. Choices:
|
|
Deprecated, please rename it to port4_ssid. Bridge LAN port 4 to SSID. |
|
Deprecated, please rename it to port5_mode. LAN port 5 mode. Choices:
|
|
Deprecated, please rename it to port5_ssid. Bridge LAN port 5 to SSID. |
|
Deprecated, please rename it to port6_mode. LAN port 6 mode. Choices:
|
|
Deprecated, please rename it to port6_ssid. Bridge LAN port 6 to SSID. |
|
Deprecated, please rename it to port7_mode. LAN port 7 mode. Choices:
|
|
Deprecated, please rename it to port7_ssid. Bridge LAN port 7 to SSID. |
|
Deprecated, please rename it to port8_mode. LAN port 8 mode. Choices:
|
|
Deprecated, please rename it to port8_ssid. Bridge LAN port 8 to SSID. |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: WTP LAN port mapping.
fortinet.fortimanager.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: <string>
port1_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port1_ssid: <string>
port2_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port2_ssid: <string>
port3_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port3_ssid: <string>
port4_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port4_ssid: <string>
port5_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port5_ssid: <string>
port6_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port6_ssid: <string>
port7_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port7_ssid: <string>
port8_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port8_ssid: <string>
port_esl_mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
port_esl_ssid: <string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |