:source: fmgr_system_npu.py :orphan: .. _fmgr_system_npu: fmgr_system_npu -- Configure NPU attributes. ++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.1.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: v6.4.7 -> v6.4.15, v7.0.1 -> 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 attributes. fortinet.fortimanager.fmgr_system_npu: # workspace_locking_adom: adom: system_npu: # capwap_offload: # dedicated_management_affinity: # dedicated_management_cpu: # fastpath: # fp_anomaly: # esp_minlen_err: # icmp_csum_err: # icmp_minlen_err: # ipv4_csum_err: # ipv4_ihl_err: # ipv4_len_err: # ipv4_opt_err: # ipv4_ttlzero_err: # ipv4_ver_err: # ipv6_exthdr_len_err: # ipv6_exthdr_order_err: # ipv6_ihl_err: # ipv6_plen_zero: # ipv6_ver_err: # tcp_csum_err: # tcp_hlen_err: # tcp_plen_err: # udp_csum_err: # udp_hlen_err: # udp_len_err: # udp_plen_err: # udplite_cover_err: # udplite_csum_err: # unknproto_minlen_err: # tcp_fin_only: # ipv4_optsecurity: # ipv6_optralert: # tcp_syn_fin: # ipv4_proto_err: # ipv6_saddr_err: # icmp_frag: # ipv4_optssrr: # ipv6_opthomeaddr: # udp_land: # ipv6_optinvld: # tcp_fin_noack: # ipv6_proto_err: # tcp_land: # ipv4_unknopt: # ipv4_optstream: # ipv6_optjumbo: # icmp_land: # tcp_winnuke: # ipv6_daddr_err: # ipv4_land: # ipv6_opttunnel: # tcp_no_flag: # ipv6_land: # ipv4_optlsrr: # ipv4_opttimestamp: # ipv4_optrr: # ipv6_optnsap: # ipv6_unknopt: # tcp_syn_data: # ipv6_optendpid: # gtpu_plen_err: # vxlan_minlen_err: # capwap_minlen_err: # gre_csum_err: # nvgre_minlen_err: # sctp_l4len_err: # tcp_hlenvsl4len_err: # sctp_crc_err: # sctp_clen_err: # uesp_minlen_err: # sctp_csum_err: # gtp_enhanced_cpu_range: # gtp_enhanced_mode: # host_shortcut_mode: # htx_gtse_quota: # intf_shaping_offload: # iph_rsvd_re_cksum: # ipsec_dec_subengine_mask: # ipsec_enc_subengine_mask: # ipsec_inbound_cache: # ipsec_mtu_override: # ipsec_over_vlink: # isf_np_queues: # cos0: # cos1: # cos2: # cos3: # cos4: # cos5: # cos6: # cos7: # lag_out_port_select: # mcast_session_accounting: # np6_cps_optimization_mode: # per_session_accounting: # port_cpu_map: # - cpu_core: # interface: # port_npu_map: # - interface: # npu_group_index: # priority_protocol: # bfd: # bgp: # slbc: # qos_mode: # rdp_offload: # recover_np6_link: # session_denied_offload: # sse_backpressure: # strip_clear_text_padding: # strip_esp_padding: # sw_eh_hash: # computation: # destination_ip_lower_16: # destination_ip_upper_16: # destination_port: # ip_protocol: # netmask_length: # source_ip_lower_16: # source_ip_upper_16: # source_port: # sw_np_bandwidth: # switch_np_hash: # uesp_offload: # np_queues: # ethernet_type: # - name: # queue: # type: # weight: # ip_protocol: # - name: # protocol: # queue: # weight: # ip_service: # - dport: # name: # protocol: # queue: # sport: # weight: # profile: # - cos0: # cos1: # cos2: # cos3: # cos4: # cos5: # cos6: # cos7: # dscp0: # dscp1: # dscp10: # dscp11: # dscp12: # dscp13: # dscp14: # dscp15: # dscp16: # dscp17: # dscp18: # dscp19: # dscp2: # dscp20: # dscp21: # dscp22: # dscp23: # dscp24: # dscp25: # dscp26: # dscp27: # dscp28: # dscp29: # dscp3: # dscp30: # dscp31: # dscp32: # dscp33: # dscp34: # dscp35: # dscp36: # dscp37: # dscp38: # dscp39: # dscp4: # dscp40: # dscp41: # dscp42: # dscp43: # dscp44: # dscp45: # dscp46: # dscp47: # dscp48: # dscp49: # dscp5: # dscp50: # dscp51: # dscp52: # dscp53: # dscp54: # dscp55: # dscp56: # dscp57: # dscp58: # dscp59: # dscp6: # dscp60: # dscp61: # dscp62: # dscp63: # dscp7: # dscp8: # dscp9: # id: # type: # weight: # scheduler: # - mode: # name: # custom_etype_lookup: # udp_timeout_profile: # - id: # udp_idle: # qtm_buf_mode: # default_qos_type: # tcp_rst_timeout: # ipsec_local_uesp_port: # htab_dedi_queue_nr: # double_level_mcast_offload: # dse_timeout: # ippool_overload_low: # pba_eim: # policy_offload_level: # max_session_timeout: # port_path_option: # ports_using_npu: # vlan_lookup_cache: # dos_options: # npu_dos_meter_mode: # npu_dos_synproxy_mode: # npu_dos_tpe_mode: # hash_tbl_spread: # tcp_timeout_profile: # - close_wait: # fin_wait: # id: # syn_sent: # syn_wait: # tcp_idle: # time_wait: # ip_reassembly: # max_timeout: # min_timeout: # status: # gtp_support: # htx_icmp_csum_chk: # hpe: # all_protocol: # arp_max: # enable_shaper: # esp_max: # high_priority: # icmp_max: # ip_frag_max: # ip_others_max: # l2_others_max: # pri_type_max: # sctp_max: # tcp_max: # tcpfin_rst_max: # tcpsyn_ack_max: # tcpsyn_max: # udp_max: # enable_queue_shaper: # exception_code: # fragment_with_sess: # fragment_without_session: # queue_shaper_max: # dsw_dts_profile: # - action: # min_limit: # profile_id: # step: # hash_config: # ipsec_ob_np_sel: # napi_break_interval: # background_sse_scan: # scan: # stats_update_interval: # udp_keepalive_interval: # scan_stale: # scan_vt: # stats_qual_access: # stats_qual_duration: # udp_qual_access: # udp_qual_duration: # inbound_dscp_copy_port: # session_acct_interval: # htab_msg_queue: # dsw_queue_dts_profile: # - iport: # name: # oport: # profile_id: # queue_select: # hw_ha_scan_interval: # ippool_overload_high: # nat46_force_ipv4_packet_forwarding: # prp_port_out: # isf_np_rx_tr_distr: # mcast_session_counting6: # prp_port_in: # rps_mode: # per_policy_accounting: # mcast_session_counting: # inbound_dscp_copy: # ipsec_host_dfclr: # process_icmp_by_host: # dedicated_tx_npu: # ull_port_mode: # sse_ha_scan: # gap: # max_session_cnt: # min_duration: # hash_ipv6_sel: # ip_fragment_offload: # ple_non_syn_tcp_action: # npu_group_effective_scope: # ipsec_STS_timeout: # ipsec_throughput_msg_frequency: # ipt_STS_timeout: # ipt_throughput_msg_frequency: # default_tcp_refresh_dir: # default_udp_refresh_dir: # nss_threads_option: # prp_session_clear_mode: # shaping_stats: # sw_tr_hash: # draco15: # tcp_udp_port: # pba_port_select_mode: # spa_port_select_mode: # split_ipsec_engines: # tunnel_over_vlink: # max_receive_unit: # npu_tcam: # - 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: # name: # 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: # icmp_rate_ctrl: # icmp_v4_bucket_size: # icmp_v4_rate: # icmp_v6_bucket_size: # icmp_v6_rate: # vxlan_offload: # icmp_error_rate_ctrl: # icmpv4_error_bucket_size: # icmpv4_error_rate: # icmpv4_error_rate_limit: # icmpv6_error_bucket_size: # icmpv6_error_rate: # icmpv6_error_rate_limit: # ipv4_session_quota: # ipv4_session_quota_high: # ipv4_session_quota_low: # ipv6_prefix_session_quota: # ipv6_prefix_session_quota_high: # ipv6_prefix_session_quota_low: # dedicated_lacp_queue: # ipsec_ordering: # sw_np_pause: # sw_np_rate: # sw_np_rate_unit: # lag_hash_gre: # use_mse_oft: # hif_queue_customize: # ike_port: # mcast_denied_ses_offload: # shadow_virtual_switch: # use_ixgbe_tx: # vxlan_mac_flapping_guard: 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)