fortios_wireless_controller_hotspot20_anqp_nai_realm.rst

source:	fortios_wireless_controller_hotspot20_anqp_nai_realm.py
orphan:

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

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

• 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

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

• ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_wireless_controller_hotspot20_anqp_nai_realm	v6.0.0 -> latest

Parameters

• access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
• enable_log - Enable/Disable logging for task. type: bool required: false default: False
• vdom - 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 default: root
• member_path - Member attribute path to operate on. type: str
• member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
• state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
• wireless_controller_hotspot20_anqp_nai_realm - Configure network access identifier (NAI) realm. type: dict more...

  	Supported Version Ranges
  wireless_controller_hotspot20_anqp_nai_realm	v6.0.0 -> latest

• nai_list - NAI list. type: list member_path: nai_list:name more...

  	Supported Version Ranges
  nai_list	v6.0.0 -> latest

• eap_method - EAP Methods. type: list member_path: nai_list:name/eap_method:index more...

  	Supported Version Ranges
  eap_method	v6.0.0 -> latest

• auth_param - EAP auth param. type: list member_path: nai_list:name/eap_method:index/auth_param:index more...

  	Supported Version Ranges
  auth_param	v6.0.0 -> latest

• id - ID of authentication parameter. type: str choices: non-eap-inner-auth, inner-auth-eap, credential, tunneled-credential more...

  	Supported Version Ranges
  id	v6.0.0 -> latest
  [non-eap-inner-auth]	v6.0.0 -> latest
  [inner-auth-eap]	v6.0.0 -> latest
  [credential]	v6.0.0 -> latest
  [tunneled-credential]	v6.0.0 -> latest

• index - Param index. see Notes. type: int required: true more...

  	Supported Version Ranges
  index	v6.0.0 -> latest

• val - Value of authentication parameter. type: str 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 more...

  	Supported Version Ranges
  val	v6.0.0 -> latest
  [eap-identity]	v6.0.0 -> latest
  [eap-md5]	v6.0.0 -> latest
  [eap-tls]	v6.0.0 -> latest
  [eap-ttls]	v6.0.0 -> latest
  [eap-peap]	v6.0.0 -> latest
  [eap-sim]	v6.0.0 -> latest
  [eap-aka]	v6.0.0 -> latest
  [eap-aka-prime]	v6.0.0 -> latest
  [non-eap-pap]	v6.0.0 -> latest
  [non-eap-chap]	v6.0.0 -> latest
  [non-eap-mschap]	v6.0.0 -> latest
  [non-eap-mschapv2]	v6.0.0 -> latest
  [cred-sim]	v6.0.0 -> latest
  [cred-usim]	v6.0.0 -> latest
  [cred-nfc]	v6.0.0 -> latest
  [cred-hardware-token]	v6.0.0 -> latest
  [cred-softoken]	v6.0.0 -> latest
  [cred-certificate]	v6.0.0 -> latest
  [cred-user-pwd]	v6.0.0 -> latest
  [cred-none]	v6.0.0 -> latest
  [cred-vendor-specific]	v6.0.0 -> latest
  [tun-cred-sim]	v6.0.0 -> latest
  [tun-cred-usim]	v6.0.0 -> latest
  [tun-cred-nfc]	v6.0.0 -> latest
  [tun-cred-hardware-token]	v6.0.0 -> latest
  [tun-cred-softoken]	v6.0.0 -> latest
  [tun-cred-certificate]	v6.0.0 -> latest
  [tun-cred-user-pwd]	v6.0.0 -> latest
  [tun-cred-anonymous]	v6.0.0 -> latest
  [tun-cred-vendor-specific]	v6.0.0 -> latest

• index - EAP method index. see Notes. type: int required: true more...

  	Supported Version Ranges
  index	v6.0.0 -> latest

• method - EAP method type. type: str choices: eap-identity, eap-md5, eap-tls, eap-ttls, eap-peap, eap-sim, eap-aka, eap-aka-prime more...

  	Supported Version Ranges
  method	v6.0.0 -> latest
  [eap-identity]	v6.0.0 -> latest
  [eap-md5]	v6.0.0 -> latest
  [eap-tls]	v6.0.0 -> latest
  [eap-ttls]	v6.0.0 -> latest
  [eap-peap]	v6.0.0 -> latest
  [eap-sim]	v6.0.0 -> latest
  [eap-aka]	v6.0.0 -> latest
  [eap-aka-prime]	v6.0.0 -> latest

• encoding - Enable/disable format in accordance with IETF RFC 4282. type: str choices: disable, enable more...

  	Supported Version Ranges
  encoding	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

• nai_realm - Configure NAI realms (delimited by a semi-colon character). type: str more...

  	Supported Version Ranges
  nai_realm	v6.0.0 -> latest

• name - NAI realm name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• name - NAI realm list name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- 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"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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

Status

• This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.