fortinet.fortios.fortios_wireless_controller_hotspot20_anqp_nai_realm (2.3.6) — module

Configure network access identifier (NAI) realm in Fortinet's FortiOS and FortiGate.

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

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and anqp_nai_realm category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure network access identifier (NAI) realm.
  fortinet.fortios.fortios_wireless_controller_hotspot20_anqp_nai_realm:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_hotspot20_anqp_nai_realm:
          nai_list:
              -
                  eap_method:
                      -
                          auth_param:
                              -
                                  id: "6"
                                  index: "<you_own_value>"
                                  val: "eap-identity"
                          index: "<you_own_value>"
                          method: "eap-identity"
                  encoding: "disable"
                  nai_realm: "<your_own_value>"
                  name: "default_name_13"
          name: "default_name_14"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

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

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

wireless_controller_hotspot20_anqp_nai_realm:
    default: null
    description:
    - Configure network access identifier (NAI) realm.
    suboptions:
      nai_list:
        description:
        - NAI list.
        elements: dict
        suboptions:
          eap_method:
            description:
            - EAP Methods.
            elements: dict
            suboptions:
              auth_param:
                description:
                - EAP auth param.
                elements: dict
                suboptions:
                  id:
                    choices:
                    - non-eap-inner-auth
                    - inner-auth-eap
                    - credential
                    - tunneled-credential
                    description:
                    - ID of authentication parameter.
                    type: str
                  index:
                    description:
                    - Param index. see <a href='#notes'>Notes</a>.
                    required: true
                    type: int
                  val:
                    choices:
                    - eap-identity
                    - eap-md5
                    - eap-tls
                    - eap-ttls
                    - eap-peap
                    - eap-sim
                    - eap-aka
                    - eap-aka-prime
                    - non-eap-pap
                    - non-eap-chap
                    - non-eap-mschap
                    - non-eap-mschapv2
                    - cred-sim
                    - cred-usim
                    - cred-nfc
                    - cred-hardware-token
                    - cred-softoken
                    - cred-certificate
                    - cred-user-pwd
                    - cred-none
                    - cred-vendor-specific
                    - tun-cred-sim
                    - tun-cred-usim
                    - tun-cred-nfc
                    - tun-cred-hardware-token
                    - tun-cred-softoken
                    - tun-cred-certificate
                    - tun-cred-user-pwd
                    - tun-cred-anonymous
                    - tun-cred-vendor-specific
                    description:
                    - Value of authentication parameter.
                    type: str
                type: list
              index:
                description:
                - EAP method index. see <a href='#notes'>Notes</a>.
                required: true
                type: int
              method:
                choices:
                - eap-identity
                - eap-md5
                - eap-tls
                - eap-ttls
                - eap-peap
                - eap-sim
                - eap-aka
                - eap-aka-prime
                description:
                - EAP method type.
                type: str
            type: list
          encoding:
            choices:
            - disable
            - enable
            description:
            - Enable/disable format in accordance with IETF RFC 4282.
            type: str
          nai_realm:
            description:
            - Configure NAI realms (delimited by a semi-colon character).
            type: str
          name:
            description:
            - NAI realm name.
            required: true
            type: str
        type: list
      name:
        description:
        - NAI realm list name.
        required: true
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str