- source
fmgr_pkg_firewall_explicitproxypolicy.py
- orphan
2.2.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.
- 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 v6.x and v7.x.
The below requirements are needed on the host that executes this module.
- ansible>=2.15.0
Supported Version Ranges: v6.2.0 -> v6.2.12
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- pkg - The parameter in requested url type: str required: true
- pkg_firewall_explicitproxypolicy - Configure Explicit proxy policies. type: dict
- action Policy action. type: str choices: [deny, accept]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- active_auth_method (Alias name: active-auth-method) Active authentication method. type: str choices: [ntlm, basic, digest, form, none, negotiate]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- application_list (Alias name: application-list) Application list. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- av_profile (Alias name: av-profile) Antivirus profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- casi_profile (Alias name: casi-profile) Casi profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- comments Comment. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- disclaimer Web proxy disclaimer setting. type: str choices: [disable, domain, policy, user]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- dlp_sensor (Alias name: dlp-sensor) Dlp sensor. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- dstaddr Destination address name. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- dstaddr_negate (Alias name: dstaddr-negate) Enable/disable negated destination address match. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- dstaddr6 Ipv6 destination address (web proxy only). type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- dstintf Destination interface name. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- global_label (Alias name: global-label) Label for global view. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- icap_profile (Alias name: icap-profile) Icap profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- identity_based (Alias name: identity-based) Enable/disable identity-based policy. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- identity_based_policy (Alias name: identity-based-policy) type: list
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- application_list (Alias name: application-list) Application list. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- av_profile (Alias name: av-profile) Antivirus profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- casi_profile (Alias name: casi-profile) Casi profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- disclaimer Web proxy disclaimer setting. type: str choices: [disable, domain, policy, user]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- dlp_sensor (Alias name: dlp-sensor) Dlp sensor. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- groups Group name. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- icap_profile (Alias name: icap-profile) Icap profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- id Id. type: int
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- ips_sensor (Alias name: ips-sensor) Ips sensor. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- logtraffic Enable/disable policy log traffic. type: str choices: [disable, all, utm]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- logtraffic_start (Alias name: logtraffic-start) Enable/disable policy log traffic start. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- mms_profile (Alias name: mms-profile) Mms profile type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- profile_group (Alias name: profile-group) Profile group type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- profile_protocol_options (Alias name: profile-protocol-options) Profile protocol options. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- profile_type (Alias name: profile-type) Profile type type: str choices: [single, group]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- replacemsg_override_group (Alias name: replacemsg-override-group) Specify authentication replacement message override group. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- scan_botnet_connections (Alias name: scan-botnet-connections) Enable/disable scanning of connections to botnet servers. type: str choices: [disable, block, monitor]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- schedule Schedule name. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- spamfilter_profile (Alias name: spamfilter-profile) Spam filter profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- ssl_ssh_profile (Alias name: ssl-ssh-profile) Ssl ssh profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- users User name. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- utm_status (Alias name: utm-status) Enable av/web/ips protection profile. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- waf_profile (Alias name: waf-profile) Web application firewall profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- webfilter_profile (Alias name: webfilter-profile) Web filter profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- application_list (Alias name: application-list) Application list. type: str
more...
- ip_based (Alias name: ip-based) Enable/disable ip-based authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- ips_sensor (Alias name: ips-sensor) Ips sensor. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- label Label for section view. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- logtraffic Enable/disable policy log traffic. type: str choices: [disable, all, utm]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- logtraffic_start (Alias name: logtraffic-start) Enable/disable policy log traffic start. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- mms_profile (Alias name: mms-profile) Mms profile type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- policyid Policy id. type: int
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- profile_group (Alias name: profile-group) Profile group type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- profile_protocol_options (Alias name: profile-protocol-options) Profile protocol options. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- profile_type (Alias name: profile-type) Profile type type: str choices: [single, group]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- proxy Explicit proxy type. type: str choices: [web, ftp, wanopt]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- replacemsg_override_group (Alias name: replacemsg-override-group) Specify authentication replacement message override group. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- require_tfa (Alias name: require-tfa) Enable/disable requirement of 2-factor authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- scan_botnet_connections (Alias name: scan-botnet-connections) Enable/disable scanning of connections to botnet servers. type: str choices: [disable, block, monitor]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- schedule Schedule name. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- service Service name. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- service_negate (Alias name: service-negate) Enable/disable negated service match. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- spamfilter_profile (Alias name: spamfilter-profile) Spam filter profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- srcaddr Source address name. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- srcaddr_negate (Alias name: srcaddr-negate) Enable/disable negated source address match. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- srcaddr6 Ipv6 source address (web proxy only). type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- ssl_ssh_profile (Alias name: ssl-ssh-profile) Ssl ssh profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- sso_auth_method (Alias name: sso-auth-method) Sso authentication method. type: str choices: [fsso, rsso, none]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- status Enable/disable policy status. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- tags Applied object tags. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- transaction_based (Alias name: transaction-based) Enable/disable transaction based authentication. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- transparent Use ip address of client to connect to server. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- utm_status (Alias name: utm-status) Enable av/web/ips protection profile. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- uuid Universally unique identifier. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- waf_profile (Alias name: waf-profile) Web application firewall profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- web_auth_cookie (Alias name: web-auth-cookie) Enable/disable web authentication cookie. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- webcache Enable/disable web cache. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- webcache_https (Alias name: webcache-https) Enable/disable web cache for https. type: str choices: [disable, any, enable]
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- webfilter_profile (Alias name: webfilter-profile) Web filter profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- webproxy_forward_server (Alias name: webproxy-forward-server) Web proxy forward server. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
- webproxy_profile (Alias name: webproxy-profile) Web proxy profile. type: str
more...
Supported Version Ranges:
v6.2.0 -> v6.2.12
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
- 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>
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:
- 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
- This module is not guaranteed to have a backwards compatible interface.
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)