Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
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 version 2.10: of fortinet.fortimanager
| Parameter | Choices/Defaults | 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 | |
| enable_log boolean |
| Enable/Disable logging for task | |
| proposed_method string |
| The overridden method for the underlying Json RPC request | |
| 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 | |
| switchcontroller_securitypolicy_8021x dictionary | the top level parameters set | ||
| auth-fail-vlan string |
| Enable to allow limited access to clients that cannot authenticate. | |
| auth-fail-vlan-id string | VLAN ID on which authentication failed. | ||
| auth-fail-vlanid integer | VLAN ID on which authentication failed. | ||
| authserver-timeout-period integer | Authentication server timeout period (3 - 15 sec, default = 3). | ||
| authserver-timeout-vlan string |
| Enable/disable the authentication server timeout VLAN to allow limited access when RADIUS is unavailable. | |
| authserver-timeout-vlanid string | Authentication server timeout VLAN name. | ||
| eap-auto-untagged-vlans string |
| Enable/disable automatic inclusion of untagged VLANs. | |
| eap-passthru string |
| Enable/disable EAP pass-through mode, allowing protocols (such as LLDP) to pass through ports for more flexible authentication. | |
| framevid-apply string |
| Enable/disable the capability to apply the EAP/MAB frame VLAN to the port native VLAN. | |
| guest-auth-delay integer | Guest authentication delay (1 - 900 sec, default = 30). | ||
| guest-vlan string |
| Enable the guest VLAN feature to allow limited access to non-802.1X-compliant clients. | |
| guest-vlan-id string | Guest VLAN name. | ||
| guest-vlanid integer | Guest VLAN ID. | ||
| mac-auth-bypass string |
| Enable/disable MAB for this policy. | |
| name string | Policy name. | ||
| open-auth string |
| Enable/disable open authentication for this policy. | |
| policy-type string |
| Policy type. | |
| radius-timeout-overwrite string |
| Enable to override the global RADIUS session timeout. | |
| security-mode string |
| Port or MAC based 802.1X security mode. | |
| user-group string | Name of user-group to assign to this MAC Authentication Bypass (MAB) policy. | ||
| 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 | |
Note
- 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 802.
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: <value in [present, absent]>
switchcontroller_securitypolicy_8021x:
auth-fail-vlan: <value in [disable, enable]>
auth-fail-vlan-id: <value of string>
auth-fail-vlanid: <value of integer>
eap-passthru: <value in [disable, enable]>
guest-auth-delay: <value of integer>
guest-vlan: <value in [disable, enable]>
guest-vlan-id: <value of string>
guest-vlanid: <value of integer>
mac-auth-bypass: <value in [disable, enable]>
name: <value of 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: <value of string>
framevid-apply: <value in [disable, enable]>
eap-auto-untagged-vlans: <value in [disable, enable]>
authserver-timeout-period: <value of integer>
authserver-timeout-vlan: <value in [disable, enable]>
authserver-timeout-vlanid: <value of string>
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. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_switchcontroller_securitypolicy_8021x_module.html