fortinet.fortimanager.fmgr_pkg_user_nacpolicy 模块 – 配置NAC策略匹配模式以识别匹配的NAC设备。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在playbook中使用它，请指定： fortinet.fortimanager.fmgr_pkg_user_nacpolicy。

fortinet.fortimanager 2.2.0中的新功能

概要

  • 此模块能够配置FortiManager设备。

  • 示例包含所有需要在使用前调整为数据源的参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问FortiManager的令牌。

adom

字符串 / 必填

请求URL中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与FortiManager API结构不同时设置为True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用FortiCloud API访问令牌验证Ansible客户端。

pkg

字符串 / 必填

请求URL中的参数 (pkg)。

pkg_user_nacpolicy

字典

设置的顶级参数。

category

字符串

NAC策略的类别。

选项

  • "device"

  • "firewall-user"

  • "ems-tag"

  • "vulnerability"

  • "fortivoice-tag"

description

字符串

NAC策略匹配模式的描述。

ems_tag

别名：ems-tag

字符串

NAC策略匹配EMS标签。

family

字符串

NAC策略匹配族。

firewall_address

别名：firewall-address

任意

(列表) 与匹配此策略的MAC关联的动态防火墙地址。

fortivoice_tag

别名：fortivoice-tag

任意

(列表) NAC策略匹配FortiVoice标签。

host

字符串

NAC策略匹配主机。

hw_vendor

别名：hw-vendor

字符串

NAC策略匹配硬件厂商。

hw_version

别名：hw-version

字符串

NAC策略匹配硬件版本。

mac

字符串

NAC策略匹配MAC地址。

match_period

别名：match-period

整数

保留匹配设备的天数

match_type

别名：match-type

字符串

根据类型匹配和保留设备。

选项

  • "dynamic"

  • "override"

name

字符串 / 必填

NAC策略名称。

os

字符串

NAC策略匹配操作系统。

severity

任意

(列表) NAC策略匹配设备漏洞严重性列表。

src

字符串

NAC策略匹配源。

ssid_policy

别名：ssid-policy

字符串

要应用于匹配的NAC策略的SSID策略。

status

字符串

启用/禁用NAC策略。

选项

  • "disable"

  • "enable"

sw_version

别名：sw-version

字符串

NAC策略匹配软件版本。

switch_auto_auth

别名：switch-auto-auth

字符串

发现并匹配nac策略时，NAC设备自动授权。

选项

  • "disable"

  • "enable"

  • "global"

switch_fortilink

别名：switch-fortilink

任意

(列表)

支持元变量

此NAC策略所属的FortiLink接口。

switch_group

别名：switch-group

任意

(列表)

支持元变量

可以应用NAC策略的已管理FortiSwitch组列表。

switch_mac_policy

别名：switch-mac-policy

任意

(列表) 要应用于匹配的NAC策略的交换机MAC策略操作。

switch_port_policy

别名：switch-port-policy

任意

(列表) 要应用于匹配的NAC策略的交换机端口策略。

switch_scope

别名：switch-scope

任意

(列表) 可以应用NAC策略的已管理FortiSwitch列表。

type

字符串

NAC策略匹配类型。

user

字符串

NAC策略匹配用户。

user_group

别名：user-group

字符串

NAC策略匹配用户组。

proposed_method

字符串

底层Json RPC请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的rc代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的rc代码列表。

状态

字符串 / 必填

创建、更新或删除对象的指令。

选项

  • “存在”

  • “不存在”

workspace_locking_adom

字符串

对于在工作区模式下运行的FortiManager，需要锁定的ADOM，值可以是global和其他包括root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁的最大时间（秒）。

默认值： 300

备注

注意

  • 从2.4.0版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在ansible.cfg中设置deprecation_warnings=False来忽略此警告。

  • 此FortiManager模块支持在工作区锁定模式下运行，顶级参数workspace_locking_adom和workspace_locking_timeout有助于完成此工作。

  • 要创建或更新对象，请使用state present指令。

  • 要删除对象，请使用state absent指令。

  • 通常，当返回非零rc时，运行一个模块可能会失败。您还可以使用参数rc_failed和rc_succeeded覆盖失败或成功的条件。

示例

- 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]>

返回值

常见返回值已在此处记录，以下是此模块特有的字段

键

描述

meta

字典

请求的结果。

返回：始终

request_url

字符串

请求的完整URL。

返回：始终

示例： "/sys/login/user"

response_code

整数

API请求的状态。

返回：始终

示例： 0

response_data

列表 / 元素=字符串

API响应。

返回：始终

response_message

字符串

API响应的描述性消息。

返回：始终

示例： "OK."

system_information

字典

目标系统的信息。

返回：始终

rc

整数

请求的状态。

返回：始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。

返回：复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈峰 (@fshen01)

  • 卢宏斌 (@fgtdev-hblu)