Try SpotterConfigure network access identifier
| "added in version" 2.0.0 of drmofu.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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>
adom:
description: the parameter (adom) in requested url
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool
hotspot20_anqpnairealm:
description: the top level parameters set
required: false
suboptions:
nai-list:
description: Nai-List.
elements: dict
suboptions:
eap-method:
description: Eap-Method.
elements: dict
suboptions:
auth-param:
description: 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.
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.
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
type: str
name:
description: NAI realm name.
type: str
type: list
name:
description: NAI realm list name.
type: str
type: dict
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list