fortinet.fortimanager.fmgr_system_npu_nputcam_tact (2.4.0) — module

Target action of TCAM.

| "added in version" 2.4.0 of fortinet.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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]>

Inputs

    
adom:
    description: The parameter (adom) in requested url.
    required: true
    type: str

npu-tcam:
    description: Deprecated, please use "npu_tcam"
    type: str

npu_tcam:
    description: The parameter (npu-tcam) in requested url.
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    type: str

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    type: str

system_npu_nputcam_tact:
    description: The top level parameters set.
    required: false
    suboptions:
      act:
        description: Tcam tact act.
        type: int
      act-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to act_v. Enable to set tact act.
        type: str
      fmtuv4-s:
        description: Deprecated, please rename it to fmtuv4_s. Tcam tact fmtuv4-s.
        type: int
      fmtuv4-s-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to fmtuv4_s_v. Enable to set tact fmtuv4-s.
        type: str
      fmtuv6-s:
        description: Deprecated, please rename it to fmtuv6_s. Tcam tact fmtuv6-s.
        type: int
      fmtuv6-s-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to fmtuv6_s_v. Enable to set tact fmtuv6-s.
        type: str
      lnkid:
        description: Tcam tact lnkid.
        type: int
      lnkid-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to lnkid_v. Enable to set tact lnkid.
        type: str
      mac-id:
        description: Deprecated, please rename it to mac_id. Tcam tact mac-id.
        type: int
      mac-id-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to mac_id_v. Enable to set tact mac-id.
        type: str
      mss-t:
        description: Deprecated, please rename it to mss_t. Tcam tact mss.
        type: int
      mss-t-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to mss_t_v. Enable to set tact mss.
        type: str
      mtuv4:
        description: Tcam tact mtuv4.
        type: int
      mtuv4-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to mtuv4_v. Enable to set tact mtuv4.
        type: str
      mtuv6:
        description: Tcam tact mtuv6.
        type: int
      mtuv6-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to mtuv6_v. Enable to set tact mtuv6.
        type: str
      slif-act:
        description: Deprecated, please rename it to slif_act. Tcam tact slif-act.
        type: int
      slif-act-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to slif_act_v. Enable to set tact slif-act.
        type: str
      sublnkid:
        description: Tcam tact sublnkid.
        type: int
      sublnkid-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to sublnkid_v. Enable to set tact sublnkid.
        type: str
      tgtv-act:
        description: Deprecated, please rename it to tgtv_act. Tcam tact tgtv-act.
        type: int
      tgtv-act-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to tgtv_act_v. Enable to set tact tgtv-act.
        type: str
      tlif-act:
        description: Deprecated, please rename it to tlif_act. Tcam tact tlif-act.
        type: int
      tlif-act-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to tlif_act_v. Enable to set tact tlif-act.
        type: str
      tpeid:
        description: Tcam tact tpeid.
        type: int
      tpeid-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to tpeid_v. Enable to set tact tpeid.
        type: str
      v6fe:
        description: Tcam tact v6fe.
        type: int
      v6fe-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to v6fe_v. Enable to set tact v6fe.
        type: str
      vep-en-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to vep_en_v. Enable to set tact vep-en.
        type: str
      vep-slid:
        description: Deprecated, please rename it to vep_slid. Tcam tact vep_slid.
        type: int
      vep-slid-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to vep_slid_v. Enable to set tact vep-slid.
        type: str
      vep_en:
        description: Tcam tact vep_en.
        type: int
      xlt-lif:
        description: Deprecated, please rename it to xlt_lif. Tcam tact xlt-lif.
        type: int
      xlt-lif-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to xlt_lif_v. Enable to set tact xlt-lif.
        type: str
      xlt-vid:
        description: Deprecated, please rename it to xlt_vid. Tcam tact xlt-vid.
        type: int
      xlt-vid-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to xlt_vid_v. Enable to set tact xlt-vid.
        type: str
    type: dict

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list