:source: fmgd_firewall_proxypolicy.py :orphan: .. _fmgd_firewall_proxypolicy: fmgd_firewall_proxypolicy -- Configure proxy policies. ++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 1.1.0 .. 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.8 -> v7.4.10, v7.6.4 -> 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 vars: ansible_httpapi_use_ssl: true ansible_httpapi_validate_certs: false ansible_httpapi_port: 443 tasks: - name: Configure proxy policies. fortinet.fmgdevice.fmgd_firewall_proxypolicy: # bypass_validation: false # workspace_locking_adom: # workspace_locking_timeout: 300 # rc_succeeded: [0, -2, -3, ...] # rc_failed: [-2, -3, ...] device: vdom: state: present # firewall_proxypolicy: policyid: 0 # Required variable, integer # access_proxy: # access_proxy6: # action: # application_list: # av_profile: # block_notification: # casb_profile: # comments: # decrypted_traffic_mirror: # detect_https_in_http_request: # device_ownership: # diameter_filter_profile: # disclaimer: # dlp_profile: # dstaddr: # dstaddr_negate: # dstaddr6: # dstintf: # emailfilter_profile: # file_filter_profile: # global_label: # groups: # http_tunnel_auth: # icap_profile: # internet_service: # internet_service_custom: # internet_service_custom_group: # internet_service_group: # internet_service_name: # internet_service_negate: # internet_service6: # internet_service6_custom: # internet_service6_custom_group: # internet_service6_group: # internet_service6_name: # internet_service6_negate: # ips_sensor: # ips_voip_filter: # label: # logtraffic: # logtraffic_start: # name: # poolname: # poolname6: # profile_group: # profile_protocol_options: # profile_type: # proxy: # redirect_url: # replacemsg_override_group: # schedule: # sctp_filter_profile: # service: # service_negate: # session_ttl: # srcaddr: # srcaddr_negate: # srcaddr6: # srcintf: # ssh_filter_profile: # ssh_policy_redirect: # ssl_ssh_profile: # status: # transparent: # users: # utm_status: # uuid: # videofilter_profile: # virtual_patch_profile: # waf_profile: # webcache: # webcache_https: # webfilter_profile: # webproxy_forward_server: # webproxy_profile: # ztna_ems_tag: # ztna_tags_match_logic: # voip_profile: # dlp_sensor: # cifs_profile: # internet_service_id: # mms_profile: # _policy_block: # dnsfilter_profile: # https_sub_category: # internet_service_fortiguard: # internet_service6_fortiguard: # isolator_server: # log_http_transaction: # telemetry_profile: # url_risk: # ztna_ems_tag_negate: # ztna_proxy: 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)