:source: fmgr_system_npu_nputcam.py :orphan: .. _fmgr_system_npu_nputcam: fmgr_system_npu_nputcam -- Configure NPU TCAM policies. +++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 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. .. contents:: :local: :depth: 1 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 v7.x. Requirements ------------ The below requirements are needed on the host that executes this module. - ansible-core>=2.16.0 FortiManager Version Compatibility ---------------------------------- .. raw:: html

Supported Version Ranges: v7.4.2 -> latest

Parameters ---------- .. raw:: html 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 -------- .. code-block:: yaml+jinja - name: Example playbook (generated based on argument schema) hosts: fortimanagers connection: httpapi gather_facts: false tasks: - name: Configure NPU TCAM policies. fortinet.fortimanager.fmgr_system_npu_nputcam: # workspace_locking_adom: adom: state: present # system_npu_nputcam: name: "your value" # Required variable, string # data: # df: # dstip: # dstipv6: # dstmac: # dstport: # ethertype: # ext_tag: # frag_off: # gen_buf_cnt: # gen_iv: # gen_l3_flags: # gen_l4_flags: # gen_pkt_ctrl: # gen_pri: # gen_pri_v: # gen_tv: # ihl: # ip4_id: # ip6_fl: # ipver: # l4_wd10: # l4_wd11: # l4_wd8: # l4_wd9: # mf: # protocol: # slink: # smac_change: # sp: # src_cfi: # src_prio: # src_updt: # srcip: # srcipv6: # srcmac: # srcport: # svid: # tcp_ack: # tcp_cwr: # tcp_ece: # tcp_fin: # tcp_push: # tcp_rst: # tcp_syn: # tcp_urg: # tgt_cfi: # tgt_prio: # tgt_updt: # tgt_v: # tos: # tp: # ttl: # tvid: # vdid: # dbg_dump: # mask: # df: # dstip: # dstipv6: # dstmac: # dstport: # ethertype: # ext_tag: # frag_off: # gen_buf_cnt: # gen_iv: # gen_l3_flags: # gen_l4_flags: # gen_pkt_ctrl: # gen_pri: # gen_pri_v: # gen_tv: # ihl: # ip4_id: # ip6_fl: # ipver: # l4_wd10: # l4_wd11: # l4_wd8: # l4_wd9: # mf: # protocol: # slink: # smac_change: # sp: # src_cfi: # src_prio: # src_updt: # srcip: # srcipv6: # srcmac: # srcport: # svid: # tcp_ack: # tcp_cwr: # tcp_ece: # tcp_fin: # tcp_push: # tcp_rst: # tcp_syn: # tcp_urg: # tgt_cfi: # tgt_prio: # tgt_updt: # tgt_v: # tos: # tp: # ttl: # tvid: # vdid: # mir_act: # vlif: # oid: # pri_act: # priority: # weight: # sact: # act: # act_v: # bmproc: # bmproc_v: # df_lif: # df_lif_v: # dfr: # dfr_v: # dmac_skip: # dmac_skip_v: # dosen: # dosen_v: # espff_proc: # espff_proc_v: # etype_pid: # etype_pid_v: # frag_proc: # frag_proc_v: # fwd: # fwd_lif: # fwd_lif_v: # fwd_tvid: # fwd_tvid_v: # fwd_v: # icpen: # icpen_v: # igmp_mld_snp: # igmp_mld_snp_v: # learn: # learn_v: # m_srh_ctrl: # m_srh_ctrl_v: # mac_id: # mac_id_v: # mss: # mss_v: # pleen: # pleen_v: # prio_pid: # prio_pid_v: # promis: # promis_v: # rfsh: # rfsh_v: # smac_skip: # smac_skip_v: # tp_smchk_v: # tp_smchk: # tpe_id: # tpe_id_v: # vdm: # vdm_v: # vdom_id: # vdom_id_v: # x_mode: # x_mode_v: # tact: # act: # act_v: # fmtuv4_s: # fmtuv4_s_v: # fmtuv6_s: # fmtuv6_s_v: # lnkid: # lnkid_v: # mac_id: # mac_id_v: # mss_t: # mss_t_v: # mtuv4: # mtuv4_v: # mtuv6: # mtuv6_v: # slif_act: # slif_act_v: # sublnkid: # sublnkid_v: # tgtv_act: # tgtv_act_v: # tlif_act: # tlif_act_v: # tpeid: # tpeid_v: # v6fe: # v6fe_v: # vep_en_v: # vep_slid: # vep_slid_v: # vep_en: # xlt_lif: # xlt_lif_v: # xlt_vid: # xlt_vid_v: # type: # vid: 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: .. raw:: html
  • 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)