- source
fmgr_system_npu_nputcam_sact.py
- orphan
2.4.0
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0:
var-name
,var name
,var.name
- New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v7.4.2 -> latest
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- npu-tcam - The parameter in requested url type: str required: true
- system_npu_nputcam_sact - Source action of TCAM. type: dict
- act Tcam sact act. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- act_v (Alias name: act-v) Enable to set sact act. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- bmproc Tcam sact bmproc. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- bmproc_v (Alias name: bmproc-v) Enable to set sact bmproc. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- df_lif (Alias name: df-lif) Tcam sact df-lif. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- df_lif_v (Alias name: df-lif-v) Enable to set sact df-lif. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- dfr Tcam sact dfr. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- dfr_v (Alias name: dfr-v) Enable to set sact dfr. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- dmac_skip (Alias name: dmac-skip) Tcam sact dmac-skip. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- dmac_skip_v (Alias name: dmac-skip-v) Enable to set sact dmac-skip. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- dosen Tcam sact dosen. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- dosen_v (Alias name: dosen-v) Enable to set sact dosen. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- espff_proc (Alias name: espff-proc) Tcam sact espff-proc. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- espff_proc_v (Alias name: espff-proc-v) Enable to set sact espff-proc. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- etype_pid (Alias name: etype-pid) Tcam sact etype-pid. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- etype_pid_v (Alias name: etype-pid-v) Enable to set sact etype-pid. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- frag_proc (Alias name: frag-proc) Tcam sact frag-proc. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- frag_proc_v (Alias name: frag-proc-v) Enable to set sact frag-proc. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- fwd Tcam sact fwd. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- fwd_lif (Alias name: fwd-lif) Tcam sact fwd-lif. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- fwd_lif_v (Alias name: fwd-lif-v) Enable to set sact fwd-lif. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- fwd_tvid (Alias name: fwd-tvid) Tcam sact fwd-tvid. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- fwd_tvid_v (Alias name: fwd-tvid-v) Enable to set sact fwd-vid. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- fwd_v (Alias name: fwd-v) Enable to set sact fwd. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- icpen Tcam sact icpen. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- icpen_v (Alias name: icpen-v) Enable to set sact icpen. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- igmp_mld_snp (Alias name: igmp-mld-snp) Tcam sact igmp-mld-snp. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- igmp_mld_snp_v (Alias name: igmp-mld-snp-v) Enable to set sact igmp-mld-snp. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- learn Tcam sact learn. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- learn_v (Alias name: learn-v) Enable to set sact learn. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- m_srh_ctrl (Alias name: m-srh-ctrl) Tcam sact m-srh-ctrl. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- m_srh_ctrl_v (Alias name: m-srh-ctrl-v) Enable to set sact m-srh-ctrl. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- mac_id (Alias name: mac-id) Tcam sact mac-id. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- mac_id_v (Alias name: mac-id-v) Enable to set sact mac-id. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- mss Tcam sact mss. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- mss_v (Alias name: mss-v) Enable to set sact mss. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- pleen Tcam sact pleen. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- pleen_v (Alias name: pleen-v) Enable to set sact pleen. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- prio_pid (Alias name: prio-pid) Tcam sact prio-pid. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- prio_pid_v (Alias name: prio-pid-v) Enable to set sact prio-pid. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- promis Tcam sact promis. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- promis_v (Alias name: promis-v) Enable to set sact promis. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- rfsh Tcam sact rfsh. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- rfsh_v (Alias name: rfsh-v) Enable to set sact rfsh. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- smac_skip (Alias name: smac-skip) Tcam sact smac-skip. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- smac_skip_v (Alias name: smac-skip-v) Enable to set sact smac-skip. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- tp_smchk_v (Alias name: tp-smchk-v) Enable to set sact tp mode. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- tp_smchk Tcam sact tp mode. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- tpe_id (Alias name: tpe-id) Tcam sact tpe-id. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- tpe_id_v (Alias name: tpe-id-v) Enable to set sact tpe-id. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- vdm Tcam sact vdm. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- vdm_v (Alias name: vdm-v) Enable to set sact vdm. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- vdom_id (Alias name: vdom-id) Tcam sact vdom-id. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- vdom_id_v (Alias name: vdom-id-v) Enable to set sact vdom-id. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
- x_mode (Alias name: x-mode) Tcam sact x-mode. type: int
more...
Supported Version Ranges:
v7.4.2 -> latest
- x_mode_v (Alias name: x-mode-v) Enable to set sact x-mode. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v7.4.2 -> latest
Note
- 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
- 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]>
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)