fortiswitch_system_snmp_sysinfo – SNMP system info configuration in Fortinet’s FortiSwitch
New in version 1.0.0.
Synopsis
This module is able to configure a FortiSwitch device by allowing the user to set and modify system_snmp feature and sysinfo category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.14
FortiSW Version Compatibility
| Supported Version Ranges | |
| fortiswitch_system_snmp_sysinfo | v7.0.0 -> latest |
Parameters
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- 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
- system_snmp_sysinfo - SNMP system info configuration. type: dict
- contact_info - Contact information. type: str
- description - System description. type: str
- engine_id - Local snmp engineID string (max 24 char). type: str
- location - System location. type: str
- status - Enable/disable snmp. type: str choices: enable, disable
- trap_high_cpu_interval - Time period over which the CPU usage is calculated. type: str choices: 1min, 10min, 30min, 1hr, 12hr, 24hr
- trap_high_cpu_threshold - CPU usage when trap is sent. type: int
- trap_log_full_threshold - Log disk usage when trap is sent. type: int
- trap_low_memory_threshold - Memory usage when trap is sent. type: int
- trap_temp_alarm_threshold - Alarm threshold degree in C. type: int
- trap_temp_warning_threshold - Warning threshold degree in C. type: int
Examples
- name: SNMP system info configuration.
fortinet.fortiswitch.fortiswitch_system_snmp_sysinfo:
system_snmp_sysinfo:
contact_info: "<your_own_value>"
description: "<your_own_value>"
engine_id: "<your_own_value>"
location: "<your_own_value>"
status: "enable"
trap_high_cpu_interval: "1min"
trap_high_cpu_threshold: "9"
trap_log_full_threshold: "10"
trap_low_memory_threshold: "11"
trap_temp_alarm_threshold: "12"
trap_temp_warning_threshold: "13"
Return Values
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 fortiSwitch image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
- http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiSwitch 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
- serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
- status - Indication of the operation's result returned: always type: str sample: success
- version - Version of the FortiSwitch returned: always type: str sample: v7.0.0
Status
This module is not guaranteed to have a backwards compatible interface.