fortinet.fortimanager.fmgr_system_npu_nputcam_mask 模块 – TCAM 的掩码字段。

注意

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

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

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

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

fortinet.fortimanager 2.4.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 客户端。

npu-tcam

字符串

已弃用，请使用 “npu_tcam”

npu_tcam

字符串

请求 URL 中的参数 (npu-tcam)。

proposed_method

字符串

底层 Json RPC 请求的重写方法。

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=整数

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

rc_succeeded

列表 / elements=整数

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

system_npu_nputcam_mask

字典

顶层参数集。

df

字符串

Tcam 掩码 ip 标志 df。

选择

  • "disable"

  • "enable"

dstip

字符串

Tcam 掩码目标 IPv4 地址。

dstipv6

字符串

Tcam 掩码目标 IPv6 地址。

dstmac

字符串

Tcam 掩码目标 macaddr。

dstport

整数

Tcam 掩码 L4 目标端口。

ethertype

字符串

Tcam 掩码以太网类型。

ext_tag

别名: ext-tag

字符串

Tcam 掩码扩展标签。

选择

  • "disable"

  • "enable"

frag_off

别名: frag-off

整数

Tcam 数据 ip 标志片段偏移量。

gen_buf_cnt

别名: gen-buf-cnt

整数

Tcam 掩码 gen info 缓冲区计数。

gen_iv

别名: gen-iv

字符串

Tcam 掩码 gen info iv。

选择

  • "invalid"

  • "valid"

gen_l3_flags

别名: gen-l3-flags

整数

Tcam 掩码 gen info L3 标志。

gen_l4_flags

别名: gen-l4-flags

整数

Tcam 掩码 gen info L4 标志。

gen_pkt_ctrl

别名: gen-pkt-ctrl

整数

Tcam 掩码 gen info 数据包控制。

gen_pri

别名: gen-pri

整数

Tcam 掩码 gen info 优先级。

gen_pri_v

别名: gen-pri-v

字符串

Tcam 掩码 gen info 优先级有效。

选择

  • "invalid"

  • "valid"

gen_tv

别名: gen-tv

字符串

Tcam 掩码 gen info tv。

选择

  • "invalid"

  • "valid"

ihl

整数

Tcam 掩码 IPv4 IHL。

ip4_id

别名: ip4-id

整数

Tcam 掩码 IPv4 ID。

ip6_fl

别名: ip6-fl

整数

Tcam 掩码 IPv6 流标签。

ipver

整数

Tcam 掩码 IP 标头版本。

l4_wd10

别名: l4-wd10

整数

Tcam 掩码 L4 word10。

l4_wd11

别名: l4-wd11

整数

Tcam 掩码 L4 word11。

l4_wd8

别名: l4-wd8

整数

Tcam 掩码 L4 word8。

l4_wd9

别名: l4-wd9

整数

Tcam 掩码 L4 word9。

mf

字符串

Tcam 掩码 ip 标志 mf。

选择

  • "disable"

  • "enable"

protocol

整数

Tcam 掩码 IP 协议。

整数

Tcam 掩码子链接。

smac_change

别名: smac-change

字符串

Tcam 掩码源 MAC 更改。

选择

  • "disable"

  • "enable"

sp

整数

Tcam 掩码源端口。

src_cfi

别名: src-cfi

字符串

Tcam 掩码源 cfi。

选择

  • "disable"

  • "enable"

src_prio

别名: src-prio

整数

Tcam 掩码源优先级。

src_updt

别名: src-updt

字符串

Tcam 掩码源更新。

选择

  • "disable"

  • "enable"

srcip

字符串

Tcam 掩码源 IPv4 地址。

srcipv6

字符串

Tcam 掩码源 IPv6 地址。

srcmac

字符串

Tcam 掩码源 MAC 地址。

srcport

整数

Tcam 掩码 L4 源端口。

svid

整数

Tcam 掩码源 VLAN ID。

tcp_ack

别名: tcp-ack

字符串

Tcam 掩码 TCP 标志 ACK。

选择

  • "disable"

  • "enable"

tcp_cwr

别名: tcp-cwr

字符串

Tcam 掩码 TCP 标志 CWR。

选择

  • "disable"

  • "enable"

tcp_ece

别名: tcp-ece

字符串

Tcam 掩码 TCP 标志 ECE。

选择

  • "disable"

  • "enable"

tcp_fin

别名: tcp-fin

字符串

Tcam 掩码 TCP 标志 FIN。

选择

  • "disable"

  • "enable"

tcp_push

别名: tcp-push

字符串

Tcam 掩码 TCP 标志 PUSH。

选择

  • "disable"

  • "enable"

tcp_rst

别名: tcp-rst

字符串

Tcam 掩码 TCP 标志 RST。

选择

  • "disable"

  • "enable"

tcp_syn

别名: tcp-syn

字符串

Tcam 掩码 TCP 标志 SYN。

选择

  • "disable"

  • "enable"

tcp_urg

别名: tcp-urg

字符串

Tcam 掩码 TCP 标志 URG。

选择

  • "disable"

  • "enable"

tgt_cfi

别名: tgt-cfi

字符串

Tcam 掩码目标 CFI。

选择

  • "disable"

  • "enable"

tgt_prio

别名: tgt-prio

整数

Tcam 掩码目标优先级。

tgt_updt

别名: tgt-updt

字符串

Tcam 掩码目标端口更新。

选择

  • "disable"

  • "enable"

tgt_v

别名: tgt-v

字符串

Tcam 掩码目标有效性。

选择

  • "invalid"

  • "valid"

tos

整数

Tcam 掩码 IP TOS。

tp

整数

Tcam 掩码目标端口。

ttl

整数

Tcam 掩码 IP TTL。

tvid

整数

Tcam 掩码目标 VLAN ID。

vdid

整数

Tcam 掩码虚拟域 ID。

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 的要锁定的 ADOM，该值可以是全局的以及包括 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 可帮助完成这项工作。

  • 通常，当返回非零 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: Mask fields of TCAM.
      fortinet.fortimanager.fmgr_system_npu_nputcam_mask:
        # 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>
        npu_tcam: <your own value>
        system_npu_nputcam_mask:
          df: <value in [disable, enable]>
          dstip: <string>
          dstipv6: <string>
          dstmac: <string>
          dstport: <integer>
          ethertype: <string>
          ext_tag: <value in [disable, enable]>
          frag_off: <integer>
          gen_buf_cnt: <integer>
          gen_iv: <value in [invalid, valid]>
          gen_l3_flags: <integer>
          gen_l4_flags: <integer>
          gen_pkt_ctrl: <integer>
          gen_pri: <integer>
          gen_pri_v: <value in [invalid, valid]>
          gen_tv: <value in [invalid, valid]>
          ihl: <integer>
          ip4_id: <integer>
          ip6_fl: <integer>
          ipver: <integer>
          l4_wd10: <integer>
          l4_wd11: <integer>
          l4_wd8: <integer>
          l4_wd9: <integer>
          mf: <value in [disable, enable]>
          protocol: <integer>
          slink: <integer>
          smac_change: <value in [disable, enable]>
          sp: <integer>
          src_cfi: <value in [disable, enable]>
          src_prio: <integer>
          src_updt: <value in [disable, enable]>
          srcip: <string>
          srcipv6: <string>
          srcmac: <string>
          srcport: <integer>
          svid: <integer>
          tcp_ack: <value in [disable, enable]>
          tcp_cwr: <value in [disable, enable]>
          tcp_ece: <value in [disable, enable]>
          tcp_fin: <value in [disable, enable]>
          tcp_push: <value in [disable, enable]>
          tcp_rst: <value in [disable, enable]>
          tcp_syn: <value in [disable, enable]>
          tcp_urg: <value in [disable, enable]>
          tgt_cfi: <value in [disable, enable]>
          tgt_prio: <integer>
          tgt_updt: <value in [disable, enable]>
          tgt_v: <value in [invalid, valid]>
          tos: <integer>
          tp: <integer>
          ttl: <integer>
          tvid: <integer>
          vdid: <integer>

返回值

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

键

描述

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

列表 / 元素=字符串

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

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)