fortinet.fortimanager.fmgr_pkg_user_nacpolicy module – Configure NAC policy matching pattern to identify matching NAC devices.

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_pkg_user_nacpolicy.

New in fortinet.fortimanager 2.2.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.
pkg string / required	The parameter (pkg) in requested url.
pkg_user_nacpolicy dictionary	The top level parameters set.
category string	Category of NAC policy. Choices: `"device"` `"firewall-user"` `"ems-tag"` `"vulnerability"` `"fortivoice-tag"`
description string	Description for the NAC policy matching pattern.
ems-tag string	Deprecated, please rename it to ems_tag. NAC policy matching EMS tag.
family string	NAC policy matching family.
firewall-address any	(list) Deprecated, please rename it to firewall_address. Dynamic firewall address to associate MAC which match this policy.
fortivoice-tag any	(list) Deprecated, please rename it to fortivoice_tag. NAC policy matching FortiVoice tag.
host string	NAC policy matching host.
hw-vendor string	Deprecated, please rename it to hw_vendor. NAC policy matching hardware vendor.
hw-version string	Deprecated, please rename it to hw_version. NAC policy matching hardware version.
mac string	NAC policy matching MAC address.
match-period integer	Deprecated, please rename it to match_period. Number of days the matched devices will be retained
match-type string	Deprecated, please rename it to match_type. Match and retain the devices based on the type. Choices: `"dynamic"` `"override"`
name string / required	NAC policy name.
os string	NAC policy matching operating system.
severity any	(list) NAC policy matching devices vulnerability severity lists.
src string	NAC policy matching source.
ssid-policy string	Deprecated, please rename it to ssid_policy. SSID policy to be applied on the matched NAC policy.
status string	Enable/disable NAC policy. Choices: `"disable"` `"enable"`
sw-version string	Deprecated, please rename it to sw_version. NAC policy matching software version.
switch-auto-auth string	Deprecated, please rename it to switch_auto_auth. NAC device auto authorization when discovered and nac-policy matched. Choices: `"disable"` `"enable"` `"global"`
switch-fortilink any	(list) Deprecated, please rename it to switch_fortilink. Support meta variable FortiLink interface for which this NAC policy belongs to.
switch-group any	(list) Deprecated, please rename it to switch_group. Support meta variable List of managed FortiSwitch groups on which NAC policy can be applied.
switch-mac-policy any	(list) Deprecated, please rename it to switch_mac_policy. Switch MAC policy action to be applied on the matched NAC policy.
switch-port-policy any	(list) Deprecated, please rename it to switch_port_policy. Switch-port-policy to be applied on the matched NAC policy.
switch-scope any	(list) Deprecated, please rename it to switch_scope. List of managed FortiSwitches on which NAC policy can be applied.
type string	NAC policy matching type.
user string	NAC policy matching user.
user-group string	Deprecated, please rename it to user_group. NAC policy matching user group.
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"`
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 NAC policy matching pattern to identify matching NAC devices.
      fortinet.fortimanager.fmgr_pkg_user_nacpolicy:
        # 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>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_user_nacpolicy:
          category: <value in [device, firewall-user, ems-tag, ...]>
          description: <string>
          ems_tag: <string>
          family: <string>
          host: <string>
          hw_vendor: <string>
          hw_version: <string>
          mac: <string>
          name: <string>
          os: <string>
          src: <string>
          ssid_policy: <string>
          status: <value in [disable, enable]>
          sw_version: <string>
          type: <string>
          user: <string>
          user_group: <string>
          severity: <list or integer>
          firewall_address: <list or string>
          fortivoice_tag: <list or string>
          match_period: <integer>
          match_type: <value in [dynamic, override]>
          switch_fortilink: <list or string>
          switch_group: <list or string>
          switch_mac_policy: <list or string>
          switch_scope: <list or string>
          switch_port_policy: <list or string>
          switch_auto_auth: <value in [disable, enable, global]>

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_pkg_user_nacpolicy module – Configure NAC policy matching pattern to identify matching NAC devices.

Synopsis

Parameters

Notes

Examples

Return Values