source: | fortios_switch_controller_remote_log.py |
---|---|
orphan: |
fortios_switch_controller_remote_log -- Configure logging by FortiSwitch device to a remote syslog server 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 switch_controller feature and remote_log 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_switch_controller_remote_log | v6.2.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
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- switch_controller_remote_log - Configure logging by FortiSwitch device to a remote syslog server. type: dict
more...
Supported Version Ranges switch_controller_remote_log v6.2.0 -> latest
- csv - Enable/disable comma-separated value (CSV) strings. type: str choices: enable, disable
more...
Supported Version Ranges csv v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
- facility - Facility to log to remote syslog server. type: str choices: kernel, user, mail, daemon, auth, syslog, lpr, news, uucp, cron, authpriv, ftp, ntp, audit, alert, clock, local0, local1, local2, local3, local4, local5, local6, local7
more...
Supported Version Ranges facility v6.2.0 -> latest
[kernel] v6.0.0 -> latest
[user] v6.0.0 -> latest
[mail] v6.0.0 -> latest
[daemon] v6.0.0 -> latest
[auth] v6.0.0 -> latest
[syslog] v6.0.0 -> latest
[lpr] v6.0.0 -> latest
[news] v6.0.0 -> latest
[uucp] v6.0.0 -> latest
[cron] v6.0.0 -> latest
[authpriv] v6.0.0 -> latest
[ftp] v6.0.0 -> latest
[ntp] v6.0.0 -> latest
[audit] v6.0.0 -> latest
[alert] v6.0.0 -> latest
[clock] v6.0.0 -> latest
[local0] v6.0.0 -> latest
[local1] v6.0.0 -> latest
[local2] v6.0.0 -> latest
[local3] v6.0.0 -> latest
[local4] v6.0.0 -> latest
[local5] v6.0.0 -> latest
[local6] v6.0.0 -> latest
[local7] v6.0.0 -> latest
- name - Remote log name. type: str required: true
more...
Supported Version Ranges name v6.2.0 -> latest
- port - Remote syslog server listening port. type: int
more...
Supported Version Ranges port v6.2.0 -> latest
- server - IPv4 address of the remote syslog server. type: str
more...
Supported Version Ranges server v6.2.0 -> latest
- severity - Severity of logs to be transferred to remote log server. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
more...
Supported Version Ranges severity v6.2.0 -> latest
[emergency] v6.0.0 -> latest
[alert] v6.0.0 -> latest
[critical] v6.0.0 -> latest
[error] v6.0.0 -> latest
[warning] v6.0.0 -> latest
[notification] v6.0.0 -> latest
[information] v6.0.0 -> latest
[debug] v6.0.0 -> latest
- status - Enable/disable logging by FortiSwitch device to a remote syslog server. type: str choices: enable, disable
more...
Supported Version Ranges status v6.2.0 -> latest
[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure logging by FortiSwitch device to a remote syslog server.
fortinet.fortios.fortios_switch_controller_remote_log:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
switch_controller_remote_log:
csv: "enable"
facility: "kernel"
name: "default_name_5"
port: "514"
server: "192.168.100.40"
severity: "emergency"
status: "enable"
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.