fortinet.fortimanager.fmgr_wtpprofile_lan (2.4.0) — module

WTP LAN port mapping.

| "added in version" 2.0.0 of fortinet.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

wtp-profile:
    description: Deprecated, please use "wtp_profile"
    type: str

wtp_profile:
    description: The parameter (wtp-profile) in requested url.
    type: str

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

wtpprofile_lan:
    description: The top level parameters set.
    required: false
    suboptions:
      port-esl-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: Deprecated, please rename it to port_esl_mode. ESL port mode.
        type: str
      port-esl-ssid:
        description: Deprecated, please rename it to port_esl_ssid. Bridge ESL port to
          SSID.
        type: str
      port-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: Deprecated, please rename it to port_mode. LAN port mode.
        type: str
      port-ssid:
        description: Deprecated, please rename it to port_ssid. Bridge LAN port to SSID.
        type: str
      port1-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: Deprecated, please rename it to port1_mode. LAN port 1 mode.
        type: str
      port1-ssid:
        description: Deprecated, please rename it to port1_ssid. Bridge LAN port 1 to
          SSID.
        type: str
      port2-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: Deprecated, please rename it to port2_mode. LAN port 2 mode.
        type: str
      port2-ssid:
        description: Deprecated, please rename it to port2_ssid. Bridge LAN port 2 to
          SSID.
        type: str
      port3-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: Deprecated, please rename it to port3_mode. LAN port 3 mode.
        type: str
      port3-ssid:
        description: Deprecated, please rename it to port3_ssid. Bridge LAN port 3 to
          SSID.
        type: str
      port4-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: Deprecated, please rename it to port4_mode. LAN port 4 mode.
        type: str
      port4-ssid:
        description: Deprecated, please rename it to port4_ssid. Bridge LAN port 4 to
          SSID.
        type: str
      port5-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: Deprecated, please rename it to port5_mode. LAN port 5 mode.
        type: str
      port5-ssid:
        description: Deprecated, please rename it to port5_ssid. Bridge LAN port 5 to
          SSID.
        type: str
      port6-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: Deprecated, please rename it to port6_mode. LAN port 6 mode.
        type: str
      port6-ssid:
        description: Deprecated, please rename it to port6_ssid. Bridge LAN port 6 to
          SSID.
        type: str
      port7-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: Deprecated, please rename it to port7_mode. LAN port 7 mode.
        type: str
      port7-ssid:
        description: Deprecated, please rename it to port7_ssid. Bridge LAN port 7 to
          SSID.
        type: str
      port8-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: Deprecated, please rename it to port8_mode. LAN port 8 mode.
        type: str
      port8-ssid:
        description: Deprecated, please rename it to port8_ssid. Bridge LAN port 8 to
          SSID.
        type: str
    type: dict

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list