- source
fmgr_spamfilter_bwl_entries.py
- orphan
2.0.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.0.0 -> v7.2.1
- 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
- bwl - The parameter in requested url type: str required: true
- spamfilter_bwl_entries - Anti-spam black/white list entries. type: dict
- action Reject, mark as spam or good email. type: str choices: [spam, clear, reject]
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- addr_type (Alias name: addr-type) Ip address type. type: str choices: [ipv4, ipv6]
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- email_pattern (Alias name: email-pattern) Email address pattern. type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- id Entry id. type: int
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- ip4_subnet (Alias name: ip4-subnet) Ipv4 network address/subnet mask bits. type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- ip6_subnet (Alias name: ip6-subnet) Ipv6 network address/subnet mask bits. type: str
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- pattern_type (Alias name: pattern-type) Wildcard pattern or regular expression. type: str choices: [wildcard, regexp]
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- status Enable/disable status. type: str choices: [disable, enable]
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
- type Entry type. type: str choices: [ip, email]
more...
Supported Version Ranges:
v6.0.0 -> v7.2.1
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: Anti-spam black/white list entries.
fortinet.fortimanager.fmgr_spamfilter_bwl_entries:
# 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>
bwl: <your own value>
state: present # <value in [present, absent]>
spamfilter_bwl_entries:
action: <value in [spam, clear, reject]>
addr_type: <value in [ipv4, ipv6]>
email_pattern: <string>
id: <integer>
ip4_subnet: <string>
ip6_subnet: <string>
pattern_type: <value in [wildcard, regexp]>
status: <value in [disable, enable]>
type: <value in [ip, email]>
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)