:source: fmgr_pkg_firewall_consolidated_policy.py :orphan: .. _fmgr_pkg_firewall_consolidated_policy: fmgr_pkg_firewall_consolidated_policy -- Configure consolidated IPv4/IPv6 policies. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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.2.0 -> v7.6.2

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 consolidated IPv4/IPv6 policies. fortinet.fortimanager.fmgr_pkg_firewall_consolidated_policy: # workspace_locking_adom: adom: pkg: state: present # pkg_firewall_consolidated_policy: policyid: 0 # Required variable, integer # action: # app_category: # app_group: # application: # application_list: # auto_asic_offload: # av_profile: # cifs_profile: # comments: # diffserv_forward: # diffserv_reverse: # diffservcode_forward: # diffservcode_rev: # dlp_sensor: # dnsfilter_profile: # dstaddr4: # dstaddr6: # dstintf: # emailfilter_profile: # fixedport: # groups: # http_policy_redirect: # icap_profile: # inbound: # inspection_mode: # internet_service: # internet_service_custom: # internet_service_custom_group: # internet_service_group: # internet_service_id: # internet_service_src: # internet_service_src_custom: # internet_service_src_custom_group: # internet_service_src_group: # internet_service_src_id: # ippool: # ips_sensor: # logtraffic: # logtraffic_start: # mms_profile: # name: # nat: # outbound: # per_ip_shaper: # poolname4: # poolname6: # profile_group: # profile_protocol_options: # profile_type: # schedule: # service: # session_ttl: # srcaddr4: # srcaddr6: # srcintf: # ssh_filter_profile: # ssh_policy_redirect: # ssl_ssh_profile: # status: # tcp_mss_receiver: # tcp_mss_sender: # traffic_shaper: # traffic_shaper_reverse: # url_category: # users: # utm_status: # uuid: # voip_profile: # vpntunnel: # waf_profile: # wanopt: # wanopt_detection: # wanopt_passive_opt: # wanopt_peer: # wanopt_profile: # webcache: # webcache_https: # webfilter_profile: # webproxy_forward_server: # webproxy_profile: # captive_portal_exempt: # dstaddr_negate: # fsso_groups: # global_label: # internet_service_negate: # internet_service_src_negate: # service_negate: # srcaddr_negate: # _policy_block: 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)