:source: fmgd_user_nacpolicy.py
:orphan:
.. _fmgd_user_nacpolicy:
fmgd_user_nacpolicy -- Configure NAC policy matching pattern to identify matching NAC devices.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- user_nacpolicy - Configure NAC policy matching pattern to identify matching NAC devices. type: dict
- category Category of nac policy. type: str choices: [device, firewall-user, ems-tag, vulnerability, fortivoice-tag]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- description Description for the nac policy matching pattern. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ems_tag (Alias name: ems-tag) Nac policy matching ems tag. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- family Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- firewall_address (Alias name: firewall-address) Dynamic firewall address to associate mac which match this policy. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fortivoice_tag (Alias name: fortivoice-tag) Nac policy matching fortivoice tag. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- host Nac policy matching host. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- hw_vendor (Alias name: hw-vendor) Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- hw_version (Alias name: hw-version) Nac policy matching hardware version. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mac Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- match_period (Alias name: match-period) Number of days the matched devices will be retained (0 - always retain) type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- match_type (Alias name: match-type) Match and retain the devices based on the type. type: str choices: [dynamic, override]
more...
Supported Version Ranges: v7.4.3 -> latest
- name Nac policy name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- os Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- severity Nac policy matching devices vulnerability severity lists. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- src Nac policy matching source. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ssid_policy (Alias name: ssid-policy) Ssid policy to be applied on the matched nac policy. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- status Enable/disable nac policy. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sw_version (Alias name: sw-version) Nac policy matching software version. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_fortilink (Alias name: switch-fortilink) Support meta variable type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_group (Alias name: switch-group) Support meta variable type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_mac_policy (Alias name: switch-mac-policy) Switch mac policy action to be applied on the matched nac policy. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- type Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- user Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- user_group (Alias name: user-group) Nac policy matching user group. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_scope (Alias name: switch-scope) List of managed fortiswitches on which nac policy can be applied. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_port_policy (Alias name: switch-port-policy) Switch-port-policy to be applied on the matched nac policy. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- switch_auto_auth (Alias name: switch-auto-auth) Nac device auto authorization when discovered and nac-policy matched. type: str choices: [disable, enable, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- match_remove (Alias name: match-remove) Options to remove the matched override devices. type: str choices: [link-down, default]
more...
Supported Version Ranges: v7.6.3 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure NAC policy matching pattern to identify matching NAC devices.
fortinet.fmgdevice.fmgd_user_nacpolicy:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
state: present #
user_nacpolicy:
name: "your value" # Required variable, string
# category:
# description:
# ems_tag:
# family:
# firewall_address:
# fortivoice_tag:
# host:
# hw_vendor:
# hw_version:
# mac:
# match_period:
# match_type:
# os:
# severity:
# src:
# ssid_policy:
# status:
# sw_version:
# switch_fortilink:
# switch_group:
# switch_mac_policy:
# type:
# user:
# user_group:
# switch_scope:
# switch_port_policy:
# switch_auto_auth:
# match_remove:
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)