fortiswitch_system_snmp_community – SNMP community 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 community 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.11

FortiSW Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.0.3
fortiswitch_system_snmp_community yes yes yes yes

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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • system_snmp_community - SNMP community configuration. type: dict
    • events - Trap snmp events. type: str choices: cpu-high, mem-low, log-full, intf-ip, ent-conf-change, llv
    • hosts - Allow hosts configuration. type: list member_path: hosts:id
      • id - Host entry id. type: int required: true
      • interface - Allow interface name. Source system.interface.name. type: str
      • ip - Allow host ip address and netmask. type: str
      • source_ip - Source ip for snmp trap. type: str
    • hosts6 - Allow hosts configuration for IPv6. type: list member_path: hosts6:id
      • id - Host6 entry id. type: int required: true
      • interface - Allow interface name. Source system.interface.name. type: str
      • ipv6 - Allow host ipv6 address. type: str
      • source_ipv6 - Source ipv6 for snmp trap. type: str
    • id - Community id. type: int required: true
    • name - Community name. type: str
    • query_v1_port - SNMP v1 query port. type: int
    • query_v1_status - Enable/disable snmp v1 query. type: str choices: enable, disable
    • query_v2c_port - SNMP v2c query port. type: int
    • query_v2c_status - Enable/disable snmp v2c query. type: str choices: enable, disable
    • status - Enable/disable this commuity. type: str choices: enable, disable
    • trap_v1_lport - SNMP v1 trap local port. type: int
    • trap_v1_rport - SNMP v1 trap remote port. type: int
    • trap_v1_status - Enable/disable snmp v1 trap. type: str choices: enable, disable
    • trap_v2c_lport - SNMP v2c trap local port. type: int
    • trap_v2c_rport - SNMP v2c trap remote port. type: int
    • trap_v2c_status - Enable/disable snmp v2c trap. type: str choices: enable, disable

Examples

- hosts: fortiswitch01
  collections:
    - fortinet.fortiswitch
  connection: httpapi
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: SNMP community configuration.
    fortiswitch_system_snmp_community:
      state: "present"
      system_snmp_community:
        events: "cpu-high"
        hosts:
         -
            id:  "5"
            interface: "<your_own_value> (source system.interface.name)"
            ip: "<your_own_value>"
            source_ip: "84.230.14.43"
        hosts6:
         -
            id:  "10"
            interface: "<your_own_value> (source system.interface.name)"
            ipv6: "<your_own_value>"
            source_ipv6: "<your_own_value>"
        id:  "14"
        name: "default_name_15"
        query_v1_port: "16"
        query_v1_status: "enable"
        query_v2c_port: "18"
        query_v2c_status: "enable"
        status: "enable"
        trap_v1_lport: "21"
        trap_v1_rport: "22"
        trap_v1_status: "enable"
        trap_v2c_lport: "24"
        trap_v2c_rport: "25"
        trap_v2c_status: "enable"

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.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.