fortinet.fortimanager.fmgr_wtpprofile_lan – WTP LAN port mapping.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_wtpprofile_lan.

New in version 2.10: of fortinet.fortimanager

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		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		Choices: no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
state string / required		Choices: present absent	the directive to create, update or delete an object
workspace_locking_adom string			the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock
wtp-profile string / required			the parameter (wtp-profile) in requested url
wtpprofile_lan dictionary			the top level parameters set
	port-mode string	Choices: offline bridge-to-wan bridge-to-ssid nat-to-wan	LAN port mode.
	port-ssid string		Bridge LAN port to SSID.
	port1-mode string	Choices: offline bridge-to-wan bridge-to-ssid nat-to-wan	LAN port 1 mode.
	port1-ssid string		Bridge LAN port 1 to SSID.
	port2-mode string	Choices: offline bridge-to-wan bridge-to-ssid nat-to-wan	LAN port 2 mode.
	port2-ssid string		Bridge LAN port 2 to SSID.
	port3-mode string	Choices: offline bridge-to-wan bridge-to-ssid nat-to-wan	LAN port 3 mode.
	port3-ssid string		Bridge LAN port 3 to SSID.
	port4-mode string	Choices: offline bridge-to-wan bridge-to-ssid nat-to-wan	LAN port 4 mode.
	port4-ssid string		Bridge LAN port 4 to SSID.
	port5-mode string	Choices: offline bridge-to-wan bridge-to-ssid nat-to-wan	LAN port 5 mode.
	port5-ssid string		Bridge LAN port 5 to SSID.
	port6-mode string	Choices: offline bridge-to-wan bridge-to-ssid nat-to-wan	LAN port 6 mode.
	port6-ssid string		Bridge LAN port 6 to SSID.
	port7-mode string	Choices: offline bridge-to-wan bridge-to-ssid nat-to-wan	LAN port 7 mode.
	port7-ssid string		Bridge LAN port 7 to SSID.
	port8-mode string	Choices: offline bridge-to-wan bridge-to-ssid nat-to-wan	LAN port 8 mode.
	port8-ssid string		Bridge LAN port 8 to SSID.

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: WTP LAN port mapping.
     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>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)