fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy module – Configure Explicit proxy policies.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy.

New in fortinet.fortimanager 2.2.0

Synopsis

• 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.

Parameters

Parameter	Comments
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
pkg string / required	The parameter (pkg) in requested url.
pkg_firewall_explicitproxypolicy dictionary	The top level parameters set.
action string	Policy action. Choices: "deny" "accept"
active_auth_method aliases: active-auth-method string	Active authentication method. Choices: "ntlm" "basic" "digest" "form" "none" "negotiate"
application_list aliases: application-list string	Application list.
av_profile aliases: av-profile string	Antivirus profile.
casi_profile aliases: casi-profile string	CASI profile.
comments string	Comment.
disclaimer string	Web proxy disclaimer setting. Choices: "disable" "domain" "policy" "user"
dlp_sensor aliases: dlp-sensor string	DLP sensor.
dstaddr string	Destination address name.
dstaddr6 string	IPv6 destination address
dstaddr_negate aliases: dstaddr-negate string	Enable/disable negated destination address match. Choices: "disable" "enable"
dstintf string	Destination interface name.
global_label aliases: global-label string	Label for global view.
icap_profile aliases: icap-profile string	ICAP profile.
identity_based aliases: identity-based string	Enable/disable identity-based policy. Choices: "disable" "enable"
identity_based_policy aliases: identity-based-policy list / elements=dictionary	Identity based policy.
application_list aliases: application-list string	Application list.
av_profile aliases: av-profile string	Antivirus profile.
casi_profile aliases: casi-profile string	CASI profile.
disclaimer string	Web proxy disclaimer setting. Choices: "disable" "domain" "policy" "user"
dlp_sensor aliases: dlp-sensor string	DLP sensor.
groups string	Group name.
icap_profile aliases: icap-profile string	ICAP profile.
id integer	ID.
ips_sensor aliases: ips-sensor string	IPS sensor.
logtraffic string	Enable/disable policy log traffic. Choices: "disable" "all" "utm"
logtraffic_start aliases: logtraffic-start string	Enable/disable policy log traffic start. Choices: "disable" "enable"
mms_profile aliases: mms-profile string	Mms profile
profile_group aliases: profile-group string	Profile group
profile_protocol_options aliases: profile-protocol-options string	Profile protocol options.
profile_type aliases: profile-type string	Profile type Choices: "single" "group"
replacemsg_override_group aliases: replacemsg-override-group string	Specify authentication replacement message override group.
scan_botnet_connections aliases: scan-botnet-connections string	Enable/disable scanning of connections to Botnet servers. Choices: "disable" "block" "monitor"
schedule string	Schedule name.
spamfilter_profile aliases: spamfilter-profile string	Spam filter profile.
ssl_ssh_profile aliases: ssl-ssh-profile string	SSL SSH Profile.
users string	User name.
utm_status aliases: utm-status string	Enable AV/web/IPS protection profile. Choices: "disable" "enable"
waf_profile aliases: waf-profile string	Web application firewall profile.
webfilter_profile aliases: webfilter-profile string	Web filter profile.
ip_based aliases: ip-based string	Enable/disable IP-based authentication. Choices: "disable" "enable"
ips_sensor aliases: ips-sensor string	IPS sensor.
label string	Label for section view.
logtraffic string	Enable/disable policy log traffic. Choices: "disable" "all" "utm"
logtraffic_start aliases: logtraffic-start string	Enable/disable policy log traffic start. Choices: "disable" "enable"
mms_profile aliases: mms-profile string	Mms profile
policyid integer / required	Policy ID.
profile_group aliases: profile-group string	Profile group
profile_protocol_options aliases: profile-protocol-options string	Profile protocol options.
profile_type aliases: profile-type string	Profile type Choices: "single" "group"
proxy string	Explicit proxy type. Choices: "web" "ftp" "wanopt"
replacemsg_override_group aliases: replacemsg-override-group string	Specify authentication replacement message override group.
require_tfa aliases: require-tfa string	Enable/disable requirement of 2-factor authentication. Choices: "disable" "enable"
scan_botnet_connections aliases: scan-botnet-connections string	Enable/disable scanning of connections to Botnet servers. Choices: "disable" "block" "monitor"
schedule string	Schedule name.
service string	Service name.
service_negate aliases: service-negate string	Enable/disable negated service match. Choices: "disable" "enable"
spamfilter_profile aliases: spamfilter-profile string	Spam filter profile.
srcaddr string	Source address name.
srcaddr6 string	IPv6 source address
srcaddr_negate aliases: srcaddr-negate string	Enable/disable negated source address match. Choices: "disable" "enable"
ssl_ssh_profile aliases: ssl-ssh-profile string	SSL SSH Profile.
sso_auth_method aliases: sso-auth-method string	SSO authentication method. Choices: "fsso" "rsso" "none"
status string	Enable/disable policy status. Choices: "disable" "enable"
tags string	Applied object tags.
transaction_based aliases: transaction-based string	Enable/disable transaction based authentication. Choices: "disable" "enable"
transparent string	Use IP address of client to connect to server. Choices: "disable" "enable"
utm_status aliases: utm-status string	Enable AV/web/IPS protection profile. Choices: "disable" "enable"
uuid string	Universally Unique IDentifier.
waf_profile aliases: waf-profile string	Web application firewall profile.
web_auth_cookie aliases: web-auth-cookie string	Enable/disable Web authentication cookie. Choices: "disable" "enable"
webcache string	Enable/disable web cache. Choices: "disable" "enable"
webcache_https aliases: webcache-https string	Enable/disable web cache for HTTPS. Choices: "disable" "any" "enable"
webfilter_profile aliases: webfilter-profile string	Web filter profile.
webproxy_forward_server aliases: webproxy-forward-server string	Web proxy forward server.
webproxy_profile aliases: webproxy-profile string	Web proxy profile.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: "present" "absent"
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

Notes

Note

• Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

• 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

- 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: Configure Explicit proxy policies.
      fortinet.fortimanager.fmgr_pkg_firewall_explicitproxypolicy:
        # 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>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_firewall_explicitproxypolicy:
          action: <value in [deny, accept]>
          active_auth_method: <value in [ntlm, basic, digest, ...]>
          application_list: <string>
          av_profile: <string>
          casi_profile: <string>
          comments: <string>
          disclaimer: <value in [disable, domain, policy, ...]>
          dlp_sensor: <string>
          dstaddr: <string>
          dstaddr_negate: <value in [disable, enable]>
          dstaddr6: <string>
          dstintf: <string>
          global_label: <string>
          icap_profile: <string>
          identity_based: <value in [disable, enable]>
          identity_based_policy:
            -
              application_list: <string>
              av_profile: <string>
              casi_profile: <string>
              disclaimer: <value in [disable, domain, policy, ...]>
              dlp_sensor: <string>
              groups: <string>
              icap_profile: <string>
              id: <integer>
              ips_sensor: <string>
              logtraffic: <value in [disable, all, utm]>
              logtraffic_start: <value in [disable, enable]>
              mms_profile: <string>
              profile_group: <string>
              profile_protocol_options: <string>
              profile_type: <value in [single, group]>
              replacemsg_override_group: <string>
              scan_botnet_connections: <value in [disable, block, monitor]>
              schedule: <string>
              spamfilter_profile: <string>
              ssl_ssh_profile: <string>
              users: <string>
              utm_status: <value in [disable, enable]>
              waf_profile: <string>
              webfilter_profile: <string>
          ip_based: <value in [disable, enable]>
          ips_sensor: <string>
          label: <string>
          logtraffic: <value in [disable, all, utm]>
          logtraffic_start: <value in [disable, enable]>
          mms_profile: <string>
          policyid: <integer>
          profile_group: <string>
          profile_protocol_options: <string>
          profile_type: <value in [single, group]>
          proxy: <value in [web, ftp, wanopt]>
          replacemsg_override_group: <string>
          require_tfa: <value in [disable, enable]>
          scan_botnet_connections: <value in [disable, block, monitor]>
          schedule: <string>
          service: <string>
          service_negate: <value in [disable, enable]>
          spamfilter_profile: <string>
          srcaddr: <string>
          srcaddr_negate: <value in [disable, enable]>
          srcaddr6: <string>
          ssl_ssh_profile: <string>
          sso_auth_method: <value in [fsso, rsso, none]>
          status: <value in [disable, enable]>
          tags: <string>
          transaction_based: <value in [disable, enable]>
          transparent: <value in [disable, enable]>
          utm_status: <value in [disable, enable]>
          uuid: <string>
          waf_profile: <string>
          web_auth_cookie: <value in [disable, enable]>
          webcache: <value in [disable, enable]>
          webcache_https: <value in [disable, any, enable]>
          webfilter_profile: <string>
          webproxy_forward_server: <string>
          webproxy_profile: <string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)