fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist_eapmethod_authparam – EAP auth param.

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr hotspot20 anqpnairealm nailist eapmethod authparam module


fortinet.fortimanager.fmgr_hotspot20_anqpnairealm_nailist_eapmethod_authparam – EAP auth param.

Note

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

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

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


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 Choices/Defaults Comments

adom

string / required

the parameter (adom) in requested url

anqp-nai-realm

string / required

the parameter (anqp-nai-realm) in requested url

bypass_validation

boolean

  • no

  • yes

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

eap-method

string / required

the parameter (eap-method) in requested url

hotspot20_anqpnairealm_nailist_eapmethod_authparam

dictionary

the top level parameters set

id

string

  • non-eap-inner-auth
  • inner-auth-eap
  • credential
  • tunneled-credential

ID of authentication parameter.

index

integer

Param index.

val

string

  • 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

Value of authentication parameter.

nai-list

string / required

the parameter (nai-list) in requested url

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

  • present
  • absent

the directive to create, update or delete an object

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

Default:

300

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



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: EAP auth param.
     fmgr_hotspot20_anqpnairealm_nailist_eapmethod_authparam:
        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>
        anqp-nai-realm: <your own value>
        nai-list: <your own value>
        eap-method: <your own value>
        state: <value in [present, absent]>
        hotspot20_anqpnairealm_nailist_eapmethod_authparam:
           id: <value in [non-eap-inner-auth, inner-auth-eap, credential, ...]>
           index: <value of integer>
           val: <value in [eap-identity, eap-md5, eap-tls, ...]>

Return Values

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

Key Returned Description

request_url

string

always

The full url requested


Sample:

/sys/login/user

response_code

integer

always

The status of api request


response_message

string

always

The descriptive message of the api response


Sample:

OK.




Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_hotspot20_anqpnairealm_nailist_eapmethod_authparam_module.html