source: | fortios_log_fortiguard_override_setting.py |
---|---|
orphan: |
fortios_log_fortiguard_override_setting -- Override global FortiCloud logging settings for this VDOM in Fortinet's FortiOS and FortiGate.
.. versionadded:: 2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortiguard feature and override_setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.14
Using member operation to add an element to an existing object.
Supported Version Ranges | |
fortios_log_fortiguard_override_setting | v6.0.0 -> latest |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- log_fortiguard_override_setting - Override global FortiCloud logging settings for this VDOM. type: dict
more...
Supported Version Ranges log_fortiguard_override_setting v6.0.0 -> latest
- access_config - Enable/disable FortiCloud access to configuration and data. type: str choices: enable, disable
more...
Supported Version Ranges access_config v7.0.2 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- max_log_rate - FortiCloud maximum log rate in MBps (0 = unlimited). type: int
more...
Supported Version Ranges max_log_rate v6.2.0 -> latest
- override - Overriding FortiCloud settings for this VDOM or use global settings. type: str choices: enable, disable
more...
Supported Version Ranges override v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- priority - Set log transmission priority. type: str choices: default, low
more...
Supported Version Ranges priority v6.2.0 -> latest
[default] v6.0.0 -> latest
[low] v6.0.0 -> latest
- status - Enable/disable logging to FortiCloud. type: str choices: enable, disable
more...
Supported Version Ranges status v6.0.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- upload_day - Day of week to roll logs. type: str
more...
Supported Version Ranges upload_day v6.0.0 -> latest
- upload_interval - Frequency of uploading log files to FortiCloud. type: str choices: daily, weekly, monthly
more...
Supported Version Ranges upload_interval v6.0.0 -> latest
[daily] v6.0.0 -> latest
[weekly] v6.0.0 -> latest
[monthly] v6.0.0 -> latest
- upload_option - Configure how log messages are sent to FortiCloud. type: str choices: store-and-upload, realtime, 1-minute, 5-minute
more...
Supported Version Ranges upload_option v6.0.0 -> latest
[store-and-upload] v6.0.0 -> latest
[realtime] v6.0.0 -> latest
[1-minute] v6.0.0 -> latest
[5-minute] v6.0.0 -> latest
- upload_time - Time of day to roll logs (hh:mm). type: str
more...
Supported Version Ranges upload_time v6.0.0 -> latest
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Override global FortiCloud logging settings for this VDOM.
fortinet.fortios.fortios_log_fortiguard_override_setting:
vdom: "{{ vdom }}"
log_fortiguard_override_setting:
access_config: "enable"
max_log_rate: "0"
override: "enable"
priority: "default"
status: "enable"
upload_day: "<your_own_value>"
upload_interval: "daily"
upload_option: "store-and-upload"
upload_time: "<your_own_value>"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.