fortinet.fortimanager.fmgr_system_npu_nputcam_sact module – Source action of TCAM.

Note

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

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

New in fortinet.fortimanager 2.4.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.

npu-tcam

string

Deprecated, please use “npu_tcam”

npu_tcam

string

The parameter (npu-tcam) in requested url.

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.

system_npu_nputcam_sact

dictionary

The top level parameters set.

act

integer

Tcam sact act.

act_v

aliases: act-v

string

Enable to set sact act.

Choices:

  • "disable"

  • "enable"

bmproc

integer

Tcam sact bmproc.

bmproc_v

aliases: bmproc-v

string

Enable to set sact bmproc.

Choices:

  • "disable"

  • "enable"

df_lif

aliases: df-lif

integer

Tcam sact df-lif.

df_lif_v

aliases: df-lif-v

string

Enable to set sact df-lif.

Choices:

  • "disable"

  • "enable"

dfr

integer

Tcam sact dfr.

dfr_v

aliases: dfr-v

string

Enable to set sact dfr.

Choices:

  • "disable"

  • "enable"

dmac_skip

aliases: dmac-skip

integer

Tcam sact dmac-skip.

dmac_skip_v

aliases: dmac-skip-v

string

Enable to set sact dmac-skip.

Choices:

  • "disable"

  • "enable"

dosen

integer

Tcam sact dosen.

dosen_v

aliases: dosen-v

string

Enable to set sact dosen.

Choices:

  • "disable"

  • "enable"

espff_proc

aliases: espff-proc

integer

Tcam sact espff-proc.

espff_proc_v

aliases: espff-proc-v

string

Enable to set sact espff-proc.

Choices:

  • "disable"

  • "enable"

etype_pid

aliases: etype-pid

integer

Tcam sact etype-pid.

etype_pid_v

aliases: etype-pid-v

string

Enable to set sact etype-pid.

Choices:

  • "disable"

  • "enable"

frag_proc

aliases: frag-proc

integer

Tcam sact frag-proc.

frag_proc_v

aliases: frag-proc-v

string

Enable to set sact frag-proc.

Choices:

  • "disable"

  • "enable"

fwd

integer

Tcam sact fwd.

fwd_lif

aliases: fwd-lif

integer

Tcam sact fwd-lif.

fwd_lif_v

aliases: fwd-lif-v

string

Enable to set sact fwd-lif.

Choices:

  • "disable"

  • "enable"

fwd_tvid

aliases: fwd-tvid

integer

Tcam sact fwd-tvid.

fwd_tvid_v

aliases: fwd-tvid-v

string

Enable to set sact fwd-vid.

Choices:

  • "disable"

  • "enable"

fwd_v

aliases: fwd-v

string

Enable to set sact fwd.

Choices:

  • "disable"

  • "enable"

icpen

integer

Tcam sact icpen.

icpen_v

aliases: icpen-v

string

Enable to set sact icpen.

Choices:

  • "disable"

  • "enable"

igmp_mld_snp

aliases: igmp-mld-snp

integer

Tcam sact igmp-mld-snp.

igmp_mld_snp_v

aliases: igmp-mld-snp-v

string

Enable to set sact igmp-mld-snp.

Choices:

  • "disable"

  • "enable"

learn

integer

Tcam sact learn.

learn_v

aliases: learn-v

string

Enable to set sact learn.

Choices:

  • "disable"

  • "enable"

m_srh_ctrl

aliases: m-srh-ctrl

integer

Tcam sact m-srh-ctrl.

m_srh_ctrl_v

aliases: m-srh-ctrl-v

string

Enable to set sact m-srh-ctrl.

Choices:

  • "disable"

  • "enable"

mac_id

aliases: mac-id

integer

Tcam sact mac-id.

mac_id_v

aliases: mac-id-v

string

Enable to set sact mac-id.

Choices:

  • "disable"

  • "enable"

mss

integer

Tcam sact mss.

mss_v

aliases: mss-v

string

Enable to set sact mss.

Choices:

  • "disable"

  • "enable"

pleen

integer

Tcam sact pleen.

pleen_v

aliases: pleen-v

string

Enable to set sact pleen.

Choices:

  • "disable"

  • "enable"

prio_pid

aliases: prio-pid

integer

Tcam sact prio-pid.

prio_pid_v

aliases: prio-pid-v

string

Enable to set sact prio-pid.

Choices:

  • "disable"

  • "enable"

promis

integer

Tcam sact promis.

promis_v

aliases: promis-v

string

Enable to set sact promis.

Choices:

  • "disable"

  • "enable"

rfsh

integer

Tcam sact rfsh.

rfsh_v

aliases: rfsh-v

string

Enable to set sact rfsh.

Choices:

  • "disable"

  • "enable"

smac_skip

aliases: smac-skip

integer

Tcam sact smac-skip.

smac_skip_v

aliases: smac-skip-v

string

Enable to set sact smac-skip.

Choices:

  • "disable"

  • "enable"

tp_smchk

integer

Tcam sact tp mode.

tp_smchk_v

aliases: tp-smchk-v

string

Enable to set sact tp mode.

Choices:

  • "disable"

  • "enable"

tpe_id

aliases: tpe-id

integer

Tcam sact tpe-id.

tpe_id_v

aliases: tpe-id-v

string

Enable to set sact tpe-id.

Choices:

  • "disable"

  • "enable"

vdm

integer

Tcam sact vdm.

vdm_v

aliases: vdm-v

string

Enable to set sact vdm.

Choices:

  • "disable"

  • "enable"

vdom_id

aliases: vdom-id

integer

Tcam sact vdom-id.

vdom_id_v

aliases: vdom-id-v

string

Enable to set sact vdom-id.

Choices:

  • "disable"

  • "enable"

x_mode

aliases: x-mode

integer

Tcam sact x-mode.

x_mode_v

aliases: x-mode-v

string

Enable to set sact x-mode.

Choices:

  • "disable"

  • "enable"

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.

  • 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: Source action of TCAM.
      fortinet.fortimanager.fmgr_system_npu_nputcam_sact:
        # 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_sact:
          act: <integer>
          act_v: <value in [disable, enable]>
          bmproc: <integer>
          bmproc_v: <value in [disable, enable]>
          df_lif: <integer>
          df_lif_v: <value in [disable, enable]>
          dfr: <integer>
          dfr_v: <value in [disable, enable]>
          dmac_skip: <integer>
          dmac_skip_v: <value in [disable, enable]>
          dosen: <integer>
          dosen_v: <value in [disable, enable]>
          espff_proc: <integer>
          espff_proc_v: <value in [disable, enable]>
          etype_pid: <integer>
          etype_pid_v: <value in [disable, enable]>
          frag_proc: <integer>
          frag_proc_v: <value in [disable, enable]>
          fwd: <integer>
          fwd_lif: <integer>
          fwd_lif_v: <value in [disable, enable]>
          fwd_tvid: <integer>
          fwd_tvid_v: <value in [disable, enable]>
          fwd_v: <value in [disable, enable]>
          icpen: <integer>
          icpen_v: <value in [disable, enable]>
          igmp_mld_snp: <integer>
          igmp_mld_snp_v: <value in [disable, enable]>
          learn: <integer>
          learn_v: <value in [disable, enable]>
          m_srh_ctrl: <integer>
          m_srh_ctrl_v: <value in [disable, enable]>
          mac_id: <integer>
          mac_id_v: <value in [disable, enable]>
          mss: <integer>
          mss_v: <value in [disable, enable]>
          pleen: <integer>
          pleen_v: <value in [disable, enable]>
          prio_pid: <integer>
          prio_pid_v: <value in [disable, enable]>
          promis: <integer>
          promis_v: <value in [disable, enable]>
          rfsh: <integer>
          rfsh_v: <value in [disable, enable]>
          smac_skip: <integer>
          smac_skip_v: <value in [disable, enable]>
          tp_smchk_v: <value in [disable, enable]>
          tp_smchk: <integer>
          tpe_id: <integer>
          tpe_id_v: <value in [disable, enable]>
          vdm: <integer>
          vdm_v: <value in [disable, enable]>
          vdom_id: <integer>
          vdom_id_v: <value in [disable, enable]>
          x_mode: <integer>
          x_mode_v: <value in [disable, enable]>

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)