fortinet.fortimanager.fmgr_wtpprofile_platform (2.4.0) — module

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

Scanned by Steampunk Spotter

• 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, FortiAP, or AP platform.
      fortinet.fortimanager.fmgr_wtpprofile_platform:
        # 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_platform:
          type: <value in [30B-50B, 60B, 80CM-81CM, ...]>
          mode: <value in [dual-5G, single-5G]>
          ddscan: <value in [disable, enable]>
          _local_platform_str: <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

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

wtpprofile_platform:
    description: The top level parameters set.
    required: false
    suboptions:
      _local_platform_str:
        description: No description.
        type: str
      ddscan:
        choices:
        - disable
        - enable
        description: Enable/disable use of one radio for dedicated dual-band scanning
          to detect RF characterization and wireless threat management.
        type: str
      mode:
        choices:
        - dual-5G
        - single-5G
        description: Configure operation mode of 5G radios
        type: str
      type:
        choices:
        - 30B-50B
        - 60B
        - 80CM-81CM
        - 220A
        - 220B
        - 210B
        - 60C
        - 222B
        - 112B
        - 320B
        - 11C
        - 14C
        - 223B
        - 28C
        - 320C
        - 221C
        - 25D
        - 222C
        - 224D
        - 214B
        - 21D
        - 24D
        - 112D
        - 223C
        - 321C
        - C220C
        - C225C
        - S321C
        - S323C
        - FWF
        - S311C
        - S313C
        - AP-11N
        - S322C
        - S321CR
        - S322CR
        - S323CR
        - S421E
        - S422E
        - S423E
        - 421E
        - 423E
        - C221E
        - C226E
        - C23JD
        - C24JE
        - C21D
        - U421E
        - U423E
        - 221E
        - 222E
        - 223E
        - S221E
        - S223E
        - U221EV
        - U223EV
        - U321EV
        - U323EV
        - 224E
        - U422EV
        - U24JEV
        - 321E
        - U431F
        - U433F
        - 231E
        - 431F
        - 433F
        - 231F
        - 432F
        - 234F
        - 23JF
        - U231F
        - 831F
        - U234F
        - U432F
        - 431FL
        - 432FR
        - 433FL
        - 231FL
        - 231G
        - 233G
        - 431G
        - 433G
        - U231G
        - U441G
        - 234G
        - 432G
        - 441K
        - 443K
        - 241K
        - 243K
        description: WTP, FortiAP or AP platform type.
        type: str
    type: dict

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