Try SpotterConfigure Explicit proxy policies.
| "added in version" 2.2.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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>
pkg:
description: The parameter (pkg) in requested url.
required: true
type: str
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
pkg_firewall_explicitproxypolicy:
description: The top level parameters set.
required: false
suboptions:
action:
choices:
- deny
- accept
description: Policy action.
type: str
active-auth-method:
choices:
- ntlm
- basic
- digest
- form
- none
- negotiate
description: Deprecated, please rename it to active_auth_method. Active authentication
method.
type: str
application-list:
description: Deprecated, please rename it to application_list. Application list.
type: str
av-profile:
description: Deprecated, please rename it to av_profile. Antivirus profile.
type: str
casi-profile:
description: Deprecated, please rename it to casi_profile. CASI profile.
type: str
comments:
description: Comment.
type: str
disclaimer:
choices:
- disable
- domain
- policy
- user
description: Web proxy disclaimer setting.
type: str
dlp-sensor:
description: Deprecated, please rename it to dlp_sensor. DLP sensor.
type: str
dstaddr:
description: Destination address name.
type: str
dstaddr-negate:
choices:
- disable
- enable
description: Deprecated, please rename it to dstaddr_negate. Enable/disable negated
destination address match.
type: str
dstaddr6:
description: IPv6 destination address
type: str
dstintf:
description: Destination interface name.
type: str
global-label:
description: Deprecated, please rename it to global_label. Label for global view.
type: str
icap-profile:
description: Deprecated, please rename it to icap_profile. ICAP profile.
type: str
identity-based:
choices:
- disable
- enable
description: Deprecated, please rename it to identity_based. Enable/disable identity-based
policy.
type: str
identity-based-policy:
description: Deprecated, please rename it to identity_based_policy.
elements: dict
suboptions:
application-list:
description: Deprecated, please rename it to application_list. Application
list.
type: str
av-profile:
description: Deprecated, please rename it to av_profile. Antivirus profile.
type: str
casi-profile:
description: Deprecated, please rename it to casi_profile. CASI profile.
type: str
disclaimer:
choices:
- disable
- domain
- policy
- user
description: Web proxy disclaimer setting.
type: str
dlp-sensor:
description: Deprecated, please rename it to dlp_sensor. DLP sensor.
type: str
groups:
description: Group name.
type: str
icap-profile:
description: Deprecated, please rename it to icap_profile. ICAP profile.
type: str
id:
description: ID.
type: int
ips-sensor:
description: Deprecated, please rename it to ips_sensor. IPS sensor.
type: str
logtraffic:
choices:
- disable
- all
- utm
description: Enable/disable policy log traffic.
type: str
logtraffic-start:
choices:
- disable
- enable
description: Deprecated, please rename it to logtraffic_start. Enable/disable
policy log traffic start.
type: str
mms-profile:
description: Deprecated, please rename it to mms_profile. Mms profile
type: str
profile-group:
description: Deprecated, please rename it to profile_group. Profile group
type: str
profile-protocol-options:
description: Deprecated, please rename it to profile_protocol_options. Profile
protocol options.
type: str
profile-type:
choices:
- single
- group
description: Deprecated, please rename it to profile_type. Profile type
type: str
replacemsg-override-group:
description: Deprecated, please rename it to replacemsg_override_group. Specify
authentication replacement message override group.
type: str
scan-botnet-connections:
choices:
- disable
- block
- monitor
description: Deprecated, please rename it to scan_botnet_connections. Enable/disable
scanning of connections to Botnet servers.
type: str
schedule:
description: Schedule name.
type: str
spamfilter-profile:
description: Deprecated, please rename it to spamfilter_profile. Spam filter
profile.
type: str
ssl-ssh-profile:
description: Deprecated, please rename it to ssl_ssh_profile. SSL SSH Profile.
type: str
users:
description: User name.
type: str
utm-status:
choices:
- disable
- enable
description: Deprecated, please rename it to utm_status. Enable AV/web/IPS
protection profile.
type: str
waf-profile:
description: Deprecated, please rename it to waf_profile. Web application
firewall profile.
type: str
webfilter-profile:
description: Deprecated, please rename it to webfilter_profile. Web filter
profile.
type: str
type: list
ip-based:
choices:
- disable
- enable
description: Deprecated, please rename it to ip_based. Enable/disable IP-based
authentication.
type: str
ips-sensor:
description: Deprecated, please rename it to ips_sensor. IPS sensor.
type: str
label:
description: Label for section view.
type: str
logtraffic:
choices:
- disable
- all
- utm
description: Enable/disable policy log traffic.
type: str
logtraffic-start:
choices:
- disable
- enable
description: Deprecated, please rename it to logtraffic_start. Enable/disable
policy log traffic start.
type: str
mms-profile:
description: Deprecated, please rename it to mms_profile. Mms profile
type: str
policyid:
description: Policy ID.
required: true
type: int
profile-group:
description: Deprecated, please rename it to profile_group. Profile group
type: str
profile-protocol-options:
description: Deprecated, please rename it to profile_protocol_options. Profile
protocol options.
type: str
profile-type:
choices:
- single
- group
description: Deprecated, please rename it to profile_type. Profile type
type: str
proxy:
choices:
- web
- ftp
- wanopt
description: Explicit proxy type.
type: str
replacemsg-override-group:
description: Deprecated, please rename it to replacemsg_override_group. Specify
authentication replacement message override group.
type: str
require-tfa:
choices:
- disable
- enable
description: Deprecated, please rename it to require_tfa. Enable/disable requirement
of 2-factor authentication.
type: str
scan-botnet-connections:
choices:
- disable
- block
- monitor
description: Deprecated, please rename it to scan_botnet_connections. Enable/disable
scanning of connections to Botnet servers.
type: str
schedule:
description: Schedule name.
type: str
service:
description: Service name.
type: str
service-negate:
choices:
- disable
- enable
description: Deprecated, please rename it to service_negate. Enable/disable negated
service match.
type: str
spamfilter-profile:
description: Deprecated, please rename it to spamfilter_profile. Spam filter profile.
type: str
srcaddr:
description: Source address name.
type: str
srcaddr-negate:
choices:
- disable
- enable
description: Deprecated, please rename it to srcaddr_negate. Enable/disable negated
source address match.
type: str
srcaddr6:
description: IPv6 source address
type: str
ssl-ssh-profile:
description: Deprecated, please rename it to ssl_ssh_profile. SSL SSH Profile.
type: str
sso-auth-method:
choices:
- fsso
- rsso
- none
description: Deprecated, please rename it to sso_auth_method. SSO authentication
method.
type: str
status:
choices:
- disable
- enable
description: Enable/disable policy status.
type: str
tags:
description: Applied object tags.
type: str
transaction-based:
choices:
- disable
- enable
description: Deprecated, please rename it to transaction_based. Enable/disable
transaction based authentication.
type: str
transparent:
choices:
- disable
- enable
description: Use IP address of client to connect to server.
type: str
utm-status:
choices:
- disable
- enable
description: Deprecated, please rename it to utm_status. Enable AV/web/IPS protection
profile.
type: str
uuid:
description: Universally Unique IDentifier.
type: str
waf-profile:
description: Deprecated, please rename it to waf_profile. Web application firewall
profile.
type: str
web-auth-cookie:
choices:
- disable
- enable
description: Deprecated, please rename it to web_auth_cookie. Enable/disable Web
authentication cookie.
type: str
webcache:
choices:
- disable
- enable
description: Enable/disable web cache.
type: str
webcache-https:
choices:
- disable
- any
- enable
description: Deprecated, please rename it to webcache_https. Enable/disable web
cache for HTTPS.
type: str
webfilter-profile:
description: Deprecated, please rename it to webfilter_profile. Web filter profile.
type: str
webproxy-forward-server:
description: Deprecated, please rename it to webproxy_forward_server. Web proxy
forward server.
type: str
webproxy-profile:
description: Deprecated, please rename it to webproxy_profile. Web proxy profile.
type: str
type: dict
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list