fortinet.fortimanager.fmgr_hotspot20_anqpnairealm – Configure network access identifier

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_hotspot20_anqpnairealm.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • 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.

Parameters

Parameter

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

hotspot20_anqpnairealm

dictionary

the top level parameters set

nai-list

list / elements=string

Nai-List.

eap-method

list / elements=string

Eap-Method.

auth-param

list / elements=string

Auth-Param.

id

string

ID of authentication parameter.

Choices:

  • non-eap-inner-auth

  • inner-auth-eap

  • credential

  • tunneled-credential

index

integer

Param index.

val

string

Value of authentication parameter.

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

index

integer

EAP method index.

method

string

EAP method type.

Choices:

  • eap-identity

  • eap-md5

  • eap-tls

  • eap-ttls

  • eap-peap

  • eap-sim

  • eap-aka

  • eap-aka-prime

encoding

string

Enable/disable format in accordance with IETF RFC 4282.

Choices:

  • disable

  • enable

nai-realm

string

Configure NAI realms (delimited by a semi-colon character).

name

string

NAI realm name.

name

string

NAI realm list name.

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- 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: Configure network access identifier
     fmgr_hotspot20_anqpnairealm:
        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>
        state: <value in [present, absent]>
        hotspot20_anqpnairealm:
           nai-list:
             -
                 eap-method:
                   -
                       auth-param:
                         -
                             id: <value in [non-eap-inner-auth, inner-auth-eap, credential, ...]>
                             index: <value of integer>
                             val: <value in [eap-identity, eap-md5, eap-tls, ...]>
                       index: <value of integer>
                       method: <value in [eap-identity, eap-md5, eap-tls, ...]>
                 encoding: <value in [disable, enable]>
                 nai-realm: <value of string>
                 name: <value of string>
           name: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)