fortinet.fortimanager.fmgr_system_npu_nputcam_tact module – Target action of TCAM.
Note
This module is part of the fortinet.fortimanager collection (version 2.5.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_system_npu_nputcam_tact.
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 |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
Deprecated, please use “npu_tcam” |
|
The parameter (npu-tcam) in requested url. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The top level parameters set. |
|
Tcam tact act. |
|
Deprecated, please rename it to act_v. Enable to set tact act. Choices:
|
|
Deprecated, please rename it to fmtuv4_s. Tcam tact fmtuv4-s. |
|
Deprecated, please rename it to fmtuv4_s_v. Enable to set tact fmtuv4-s. Choices:
|
|
Deprecated, please rename it to fmtuv6_s. Tcam tact fmtuv6-s. |
|
Deprecated, please rename it to fmtuv6_s_v. Enable to set tact fmtuv6-s. Choices:
|
|
Tcam tact lnkid. |
|
Deprecated, please rename it to lnkid_v. Enable to set tact lnkid. Choices:
|
|
Deprecated, please rename it to mac_id. Tcam tact mac-id. |
|
Deprecated, please rename it to mac_id_v. Enable to set tact mac-id. Choices:
|
|
Deprecated, please rename it to mss_t. Tcam tact mss. |
|
Deprecated, please rename it to mss_t_v. Enable to set tact mss. Choices:
|
|
Tcam tact mtuv4. |
|
Deprecated, please rename it to mtuv4_v. Enable to set tact mtuv4. Choices:
|
|
Tcam tact mtuv6. |
|
Deprecated, please rename it to mtuv6_v. Enable to set tact mtuv6. Choices:
|
|
Deprecated, please rename it to slif_act. Tcam tact slif-act. |
|
Deprecated, please rename it to slif_act_v. Enable to set tact slif-act. Choices:
|
|
Tcam tact sublnkid. |
|
Deprecated, please rename it to sublnkid_v. Enable to set tact sublnkid. Choices:
|
|
Deprecated, please rename it to tgtv_act. Tcam tact tgtv-act. |
|
Deprecated, please rename it to tgtv_act_v. Enable to set tact tgtv-act. Choices:
|
|
Deprecated, please rename it to tlif_act. Tcam tact tlif-act. |
|
Deprecated, please rename it to tlif_act_v. Enable to set tact tlif-act. Choices:
|
|
Tcam tact tpeid. |
|
Deprecated, please rename it to tpeid_v. Enable to set tact tpeid. Choices:
|
|
Tcam tact v6fe. |
|
Deprecated, please rename it to v6fe_v. Enable to set tact v6fe. Choices:
|
|
Deprecated, please rename it to vep_en_v. Enable to set tact vep-en. Choices:
|
|
Deprecated, please rename it to vep_slid. Tcam tact vep_slid. |
|
Deprecated, please rename it to vep_slid_v. Enable to set tact vep-slid. Choices:
|
|
Tcam tact vep_en. |
|
Deprecated, please rename it to xlt_lif. Tcam tact xlt-lif. |
|
Deprecated, please rename it to xlt_lif_v. Enable to set tact xlt-lif. Choices:
|
|
Deprecated, please rename it to xlt_vid. Tcam tact xlt-vid. |
|
Deprecated, please rename it to xlt_vid_v. Enable to set tact xlt-vid. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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: Target action of TCAM.
fortinet.fortimanager.fmgr_system_npu_nputcam_tact:
# 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_tact:
act: <integer>
act_v: <value in [disable, enable]>
fmtuv4_s: <integer>
fmtuv4_s_v: <value in [disable, enable]>
fmtuv6_s: <integer>
fmtuv6_s_v: <value in [disable, enable]>
lnkid: <integer>
lnkid_v: <value in [disable, enable]>
mac_id: <integer>
mac_id_v: <value in [disable, enable]>
mss_t: <integer>
mss_t_v: <value in [disable, enable]>
mtuv4: <integer>
mtuv4_v: <value in [disable, enable]>
mtuv6: <integer>
mtuv6_v: <value in [disable, enable]>
slif_act: <integer>
slif_act_v: <value in [disable, enable]>
sublnkid: <integer>
sublnkid_v: <value in [disable, enable]>
tgtv_act: <integer>
tgtv_act_v: <value in [disable, enable]>
tlif_act: <integer>
tlif_act_v: <value in [disable, enable]>
tpeid: <integer>
tpeid_v: <value in [disable, enable]>
v6fe: <integer>
v6fe_v: <value in [disable, enable]>
vep_en_v: <value in [disable, enable]>
vep_slid: <integer>
vep_slid_v: <value in [disable, enable]>
vep_en: <integer>
xlt_lif: <integer>
xlt_lif_v: <value in [disable, enable]>
xlt_vid: <integer>
xlt_vid_v: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |