fortinet.fortimanager.fmgr_switchcontroller_securitypolicy_8021x module – Configure 802.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

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
access_token string	The token to access FortiManager without using username and password.
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: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	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"`
switchcontroller_securitypolicy_8021x dictionary	The top level parameters set.
auth-fail-vlan string	Deprecated, please rename it to auth_fail_vlan. Enable to allow limited access to clients that cannot authenticate. Choices: `"disable"` `"enable"`
auth-fail-vlan-id string	Deprecated, please rename it to auth_fail_vlan_id. VLAN ID on which authentication failed.
auth-fail-vlanid integer	Deprecated, please rename it to auth_fail_vlanid. VLAN ID on which authentication failed.
auth-order string	Deprecated, please rename it to auth_order. Configure authentication order. Choices: `"dot1x-mab"` `"mab-dot1x"` `"mab"`
auth-priority string	Deprecated, please rename it to auth_priority. Configure authentication priority. Choices: `"dot1x-mab"` `"mab-dot1x"` `"legacy"`
authserver-timeout-period integer	Deprecated, please rename it to authserver_timeout_period. Authentication server timeout period
authserver-timeout-tagged string	Deprecated, please rename it to authserver_timeout_tagged. Configure timeout option for the tagged VLAN which allows limit… Choices: `"static"` `"disable"` `"lldp-voice"`
authserver-timeout-tagged-vlanid any	(list) Deprecated, please rename it to authserver_timeout_tagged_vlanid. Tagged VLAN name for which the timeout option is …
authserver-timeout-vlan string	Deprecated, please rename it to authserver_timeout_vlan. Enable/disable the authentication server timeout VLAN to allow li… Choices: `"disable"` `"enable"`
authserver-timeout-vlanid string	Deprecated, please rename it to authserver_timeout_vlanid. Authentication server timeout VLAN name.
dacl string	Enable/disable dynamic access control list on this interface. Choices: `"disable"` `"enable"`
eap-auto-untagged-vlans string	Deprecated, please rename it to eap_auto_untagged_vlans. Enable/disable automatic inclusion of untagged VLANs. Choices: `"disable"` `"enable"`
eap-passthru string	Deprecated, please rename it to eap_passthru. Enable/disable EAP pass-through mode, allowing protocols Choices: `"disable"` `"enable"`
framevid-apply string	Deprecated, please rename it to framevid_apply. Enable/disable the capability to apply the EAP/MAB frame VLAN to the port … Choices: `"disable"` `"enable"`
guest-auth-delay integer	Deprecated, please rename it to guest_auth_delay. Guest authentication delay
guest-vlan string	Deprecated, please rename it to guest_vlan. Enable the guest VLAN feature to allow limited access to non-802. Choices: `"disable"` `"enable"`
guest-vlan-id string	Deprecated, please rename it to guest_vlan_id. Guest VLAN name.
guest-vlanid integer	Deprecated, please rename it to guest_vlanid. Guest VLAN ID.
mac-auth-bypass string	Deprecated, please rename it to mac_auth_bypass. Enable/disable MAB for this policy. Choices: `"disable"` `"enable"`
name string / required	Policy name.
open-auth string	Deprecated, please rename it to open_auth. Enable/disable open authentication for this policy. Choices: `"disable"` `"enable"`
policy-type string	Deprecated, please rename it to policy_type. Policy type. Choices: `"802.1X"`
radius-timeout-overwrite string	Deprecated, please rename it to radius_timeout_overwrite. Enable to override the global RADIUS session timeout. Choices: `"disable"` `"enable"`
security-mode string	Deprecated, please rename it to security_mode. Port or MAC based 802. Choices: `"802.1X"` `"802.1X-mac-based"`
user-group any	(list or str) Deprecated, please rename it to user_group. Name of user-group to assign to this MAC Authentication Bypass
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

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
meta dictionary	The result of the request. Returned: always
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_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

fortinet.fortimanager.fmgr_switchcontroller_securitypolicy_8021x module – Configure 802.

Synopsis

Parameters

Notes

Examples

Return Values