fortinet.fortimanager.fmgr_switchcontroller_securitypolicy_8021x module – Configure 802.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
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_switchcontroller_securitypolicy_8021x.
New in fortinet.fortimanager 2.0.0
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 |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Enable to allow limited access to clients that cannot authenticate. Choices:
|
|
VLAN ID on which authentication failed. |
|
VLAN ID on which authentication failed. |
|
Configure authentication order. Choices:
|
|
Configure authentication priority. Choices:
|
|
Authentication server timeout period |
|
Configure timeout option for the tagged VLAN which allows limited access when the authentication server is unavailable. Choices:
|
|
(list) Tagged VLAN name for which the timeout option is applied to |
|
Enable/disable the authentication server timeout VLAN to allow limited access when RADIUS is unavailable. Choices:
|
|
Authentication server timeout VLAN name. |
|
Enable/disable dynamic access control list on this interface. Choices:
|
|
Enable/disable automatic inclusion of untagged VLANs. Choices:
|
|
Enable/disable EAP pass-through mode, allowing protocols Choices:
|
|
Enable/disable the capability to apply the EAP/MAB frame VLAN to the port native VLAN. Choices:
|
|
Guest authentication delay |
|
Enable the guest VLAN feature to allow limited access to non-802. Choices:
|
|
Guest VLAN name. |
|
Guest VLAN ID. |
|
Enable/disable MAB for this policy. Choices:
|
|
Policy name. |
|
Enable/disable open authentication for this policy. Choices:
|
|
Policy type. Choices:
|
|
Enable to override the global RADIUS session timeout. Choices:
|
|
Port or MAC based 802. Choices:
|
|
(list or str) Name of user-group to assign to this MAC Authentication Bypass |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure 802.
fortinet.fortimanager.fmgr_switchcontroller_securitypolicy_8021x:
# 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: present # <value in [present, absent]>
switchcontroller_securitypolicy_8021x:
auth_fail_vlan: <value in [disable, enable]>
auth_fail_vlan_id: <string>
auth_fail_vlanid: <integer>
eap_passthru: <value in [disable, enable]>
guest_auth_delay: <integer>
guest_vlan: <value in [disable, enable]>
guest_vlan_id: <string>
guest_vlanid: <integer>
mac_auth_bypass: <value in [disable, enable]>
name: <string>
open_auth: <value in [disable, enable]>
policy_type: <value in [802.1X]>
radius_timeout_overwrite: <value in [disable, enable]>
security_mode: <value in [802.1X, 802.1X-mac-based]>
user_group: <list or string>
framevid_apply: <value in [disable, enable]>
eap_auto_untagged_vlans: <value in [disable, enable]>
authserver_timeout_period: <integer>
authserver_timeout_vlan: <value in [disable, enable]>
authserver_timeout_vlanid: <string>
authserver_timeout_tagged: <value in [static, disable, lldp-voice]>
authserver_timeout_tagged_vlanid: <list or string>
dacl: <value in [disable, enable]>
auth_order: <value in [dot1x-mab, mab-dot1x, mab]>
auth_priority: <value in [dot1x-mab, mab-dot1x, legacy]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |