drmofu.fortimanager.fmgr_wtpprofile_lan (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

 - 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>
            port-esl-mode: <value in [offline, bridge-to-wan, bridge-to-ssid, ...]>
            port-esl-ssid: <value of 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
    required: false
    type: list

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

wtp-profile:
    description: the parameter (wtp-profile) in requested url
    required: true
    type: str

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

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    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: ESL port mode.
        type: str
      port-esl-ssid:
        description: Bridge ESL port to SSID.
        type: str
      port-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: LAN port mode.
        type: str
      port-ssid:
        description: Bridge LAN port to SSID.
        type: str
      port1-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: LAN port 1 mode.
        type: str
      port1-ssid:
        description: Bridge LAN port 1 to SSID.
        type: str
      port2-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: LAN port 2 mode.
        type: str
      port2-ssid:
        description: Bridge LAN port 2 to SSID.
        type: str
      port3-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: LAN port 3 mode.
        type: str
      port3-ssid:
        description: Bridge LAN port 3 to SSID.
        type: str
      port4-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: LAN port 4 mode.
        type: str
      port4-ssid:
        description: Bridge LAN port 4 to SSID.
        type: str
      port5-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: LAN port 5 mode.
        type: str
      port5-ssid:
        description: Bridge LAN port 5 to SSID.
        type: str
      port6-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: LAN port 6 mode.
        type: str
      port6-ssid:
        description: Bridge LAN port 6 to SSID.
        type: str
      port7-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: LAN port 7 mode.
        type: str
      port7-ssid:
        description: Bridge LAN port 7 to SSID.
        type: str
      port8-mode:
        choices:
        - offline
        - bridge-to-wan
        - bridge-to-ssid
        - nat-to-wan
        description: LAN port 8 mode.
        type: str
      port8-ssid:
        description: 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.
    required: false
    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.
    required: false
    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.
    required: false
    type: str

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

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    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