fmgr_system_npu_nputcam_tact – Target action of TCAM.

Added in version 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.

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.2 -> latest

Parameters

  • 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_tact - Target action of TCAM. type: dict
    • act Tcam tact act. type: int more...
    • act_v (Alias name: act-v) Enable to set tact act. type: str choices: [disable, enable] more...
    • fmtuv4_s (Alias name: fmtuv4-s) Tcam tact fmtuv4-s. type: int more...
    • fmtuv4_s_v (Alias name: fmtuv4-s-v) Enable to set tact fmtuv4-s. type: str choices: [disable, enable] more...
    • fmtuv6_s (Alias name: fmtuv6-s) Tcam tact fmtuv6-s. type: int more...
    • fmtuv6_s_v (Alias name: fmtuv6-s-v) Enable to set tact fmtuv6-s. type: str choices: [disable, enable] more...
    • lnkid Tcam tact lnkid. type: int more...
    • lnkid_v (Alias name: lnkid-v) Enable to set tact lnkid. type: str choices: [disable, enable] more...
    • mac_id (Alias name: mac-id) Tcam tact mac-id. type: int more...
    • mac_id_v (Alias name: mac-id-v) Enable to set tact mac-id. type: str choices: [disable, enable] more...
    • mss_t (Alias name: mss-t) Tcam tact mss. type: int more...
    • mss_t_v (Alias name: mss-t-v) Enable to set tact mss. type: str choices: [disable, enable] more...
    • mtuv4 Tcam tact mtuv4. type: int more...
    • mtuv4_v (Alias name: mtuv4-v) Enable to set tact mtuv4. type: str choices: [disable, enable] more...
    • mtuv6 Tcam tact mtuv6. type: int more...
    • mtuv6_v (Alias name: mtuv6-v) Enable to set tact mtuv6. type: str choices: [disable, enable] more...
    • slif_act (Alias name: slif-act) Tcam tact slif-act. type: int more...
    • slif_act_v (Alias name: slif-act-v) Enable to set tact slif-act. type: str choices: [disable, enable] more...
    • sublnkid Tcam tact sublnkid. type: int more...
    • sublnkid_v (Alias name: sublnkid-v) Enable to set tact sublnkid. type: str choices: [disable, enable] more...
    • tgtv_act (Alias name: tgtv-act) Tcam tact tgtv-act. type: int more...
    • tgtv_act_v (Alias name: tgtv-act-v) Enable to set tact tgtv-act. type: str choices: [disable, enable] more...
    • tlif_act (Alias name: tlif-act) Tcam tact tlif-act. type: int more...
    • tlif_act_v (Alias name: tlif-act-v) Enable to set tact tlif-act. type: str choices: [disable, enable] more...
    • tpeid Tcam tact tpeid. type: int more...
    • tpeid_v (Alias name: tpeid-v) Enable to set tact tpeid. type: str choices: [disable, enable] more...
    • v6fe Tcam tact v6fe. type: int more...
    • v6fe_v (Alias name: v6fe-v) Enable to set tact v6fe. type: str choices: [disable, enable] more...
    • vep_en_v (Alias name: vep-en-v) Enable to set tact vep-en. type: str choices: [disable, enable] more...
    • vep_slid (Alias name: vep-slid) Tcam tact vep_slid. type: int more...
    • vep_slid_v (Alias name: vep-slid-v) Enable to set tact vep-slid. type: str choices: [disable, enable] more...
    • vep_en Tcam tact vep_en. type: int more...
    • xlt_lif (Alias name: xlt-lif) Tcam tact xlt-lif. type: int more...
    • xlt_lif_v (Alias name: xlt-lif-v) Enable to set tact xlt-lif. type: str choices: [disable, enable] more...
    • xlt_vid (Alias name: xlt-vid) Tcam tact xlt-vid. type: int more...
    • xlt_vid_v (Alias name: xlt-vid-v) Enable to set tact xlt-vid. type: str choices: [disable, enable] more...

Notes

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

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)