infra_ssids - FortiAP SSID Resource

Added in version 1.0.0.

Synopsis

FortiAP SSID Resource.

Use API “/resource-api/v2/infra/ssids”.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.17.0

Parameters

  • state The state of the module. "present" means create or update the resource, "absent" means delete the resource.type: strchoices: ['present', 'absent']default: present
  • force_behavior Specify this option to force the method to use to interact with the resource.type: strchoices: ['none', 'read', 'create', 'update', 'delete']default: none
  • bypass_validation Bypass validation of the module.type: booldefault: False
  • params The parameters of the module.[Required]type: dict
    • primary_key [Required]type: str
    • wifi_ssid type: str
    • broadcast_ssid type: strchoices: ['disable', 'enable']
    • client_limit type: int
    • security_mode type: strchoices: ['captive-portal', 'open', 'wpa2-only-enterprise', 'wpa2-only-personal', 'wpa2-only-personal+captive-portal', 'wpa3-only-enterprise', 'wpa3-sae']
    • captive_portal type: bool
    • security_groups type: listelements: dict
      • primary_key type: str
      • datasource type: str
    • pre_shared_key type: str
    • radius_server type: dict
      • primary_key type: str
      • datasource type: str
    • user_groups type: listelements: dict
      • datasource type: str

Examples

- name: Infrastructure SSIDs
  hosts: fortisase
  gather_facts: false
  vars:
    primary_key: "example"
  tasks:
    - name: Create/Update Infrastructure SSIDs
      fortinet.fortisase.infra_ssids:
        state: present
        params:
          primary_key: "{{ primary_key }}"
          broadcast_ssid: "enable"
          security_mode: "wpa2-only-personal"
          pre_shared_key: "1234567890"
          wifi_ssid: "wifi_ssid_example"
          client_limit: 101
    - name: Delete Infrastructure SSIDs
      fortinet.fortisase.infra_ssids:
        state: absent
        params:
          primary_key: "{{ primary_key }}"

Return Values

  • http_code type: intreturned: always
  • response type: rawreturned: always

Authors

  • Xinwei Du (@dux-fortinet)