fortinet.fortimanager.fmgr_system_npu_nputcam_sact (2.4.0) — module

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

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_sact:
    description: The top level parameters set.
    required: false
    suboptions:
      act:
        description: Tcam sact act.
        type: int
      act-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to act_v. Enable to set sact act.
        type: str
      bmproc:
        description: Tcam sact bmproc.
        type: int
      bmproc-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to bmproc_v. Enable to set sact bmproc.
        type: str
      df-lif:
        description: Deprecated, please rename it to df_lif. Tcam sact df-lif.
        type: int
      df-lif-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to df_lif_v. Enable to set sact df-lif.
        type: str
      dfr:
        description: Tcam sact dfr.
        type: int
      dfr-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dfr_v. Enable to set sact dfr.
        type: str
      dmac-skip:
        description: Deprecated, please rename it to dmac_skip. Tcam sact dmac-skip.
        type: int
      dmac-skip-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dmac_skip_v. Enable to set sact dmac-skip.
        type: str
      dosen:
        description: Tcam sact dosen.
        type: int
      dosen-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to dosen_v. Enable to set sact dosen.
        type: str
      espff-proc:
        description: Deprecated, please rename it to espff_proc. Tcam sact espff-proc.
        type: int
      espff-proc-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to espff_proc_v. Enable to set sact
          espff-proc.
        type: str
      etype-pid:
        description: Deprecated, please rename it to etype_pid. Tcam sact etype-pid.
        type: int
      etype-pid-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to etype_pid_v. Enable to set sact etype-pid.
        type: str
      frag-proc:
        description: Deprecated, please rename it to frag_proc. Tcam sact frag-proc.
        type: int
      frag-proc-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to frag_proc_v. Enable to set sact frag-proc.
        type: str
      fwd:
        description: Tcam sact fwd.
        type: int
      fwd-lif:
        description: Deprecated, please rename it to fwd_lif. Tcam sact fwd-lif.
        type: int
      fwd-lif-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to fwd_lif_v. Enable to set sact fwd-lif.
        type: str
      fwd-tvid:
        description: Deprecated, please rename it to fwd_tvid. Tcam sact fwd-tvid.
        type: int
      fwd-tvid-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to fwd_tvid_v. Enable to set sact fwd-vid.
        type: str
      fwd-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to fwd_v. Enable to set sact fwd.
        type: str
      icpen:
        description: Tcam sact icpen.
        type: int
      icpen-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to icpen_v. Enable to set sact icpen.
        type: str
      igmp-mld-snp:
        description: Deprecated, please rename it to igmp_mld_snp. Tcam sact igmp-mld-snp.
        type: int
      igmp-mld-snp-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to igmp_mld_snp_v. Enable to set sact
          igmp-mld-snp.
        type: str
      learn:
        description: Tcam sact learn.
        type: int
      learn-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to learn_v. Enable to set sact learn.
        type: str
      m-srh-ctrl:
        description: Deprecated, please rename it to m_srh_ctrl. Tcam sact m-srh-ctrl.
        type: int
      m-srh-ctrl-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to m_srh_ctrl_v. Enable to set sact
          m-srh-ctrl.
        type: str
      mac-id:
        description: Deprecated, please rename it to mac_id. Tcam sact mac-id.
        type: int
      mac-id-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to mac_id_v. Enable to set sact mac-id.
        type: str
      mss:
        description: Tcam sact mss.
        type: int
      mss-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to mss_v. Enable to set sact mss.
        type: str
      pleen:
        description: Tcam sact pleen.
        type: int
      pleen-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to pleen_v. Enable to set sact pleen.
        type: str
      prio-pid:
        description: Deprecated, please rename it to prio_pid. Tcam sact prio-pid.
        type: int
      prio-pid-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to prio_pid_v. Enable to set sact prio-pid.
        type: str
      promis:
        description: Tcam sact promis.
        type: int
      promis-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to promis_v. Enable to set sact promis.
        type: str
      rfsh:
        description: Tcam sact rfsh.
        type: int
      rfsh-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to rfsh_v. Enable to set sact rfsh.
        type: str
      smac-skip:
        description: Deprecated, please rename it to smac_skip. Tcam sact smac-skip.
        type: int
      smac-skip-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to smac_skip_v. Enable to set sact smac-skip.
        type: str
      tp-smchk-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to tp_smchk_v. Enable to set sact tp
          mode.
        type: str
      tp_smchk:
        description: Tcam sact tp mode.
        type: int
      tpe-id:
        description: Deprecated, please rename it to tpe_id. Tcam sact tpe-id.
        type: int
      tpe-id-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to tpe_id_v. Enable to set sact tpe-id.
        type: str
      vdm:
        description: Tcam sact vdm.
        type: int
      vdm-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to vdm_v. Enable to set sact vdm.
        type: str
      vdom-id:
        description: Deprecated, please rename it to vdom_id. Tcam sact vdom-id.
        type: int
      vdom-id-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to vdom_id_v. Enable to set sact vdom-id.
        type: str
      x-mode:
        description: Deprecated, please rename it to x_mode. Tcam sact x-mode.
        type: int
      x-mode-v:
        choices:
        - disable
        - enable
        description: Deprecated, please rename it to x_mode_v. Enable to set sact x-mode.
        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