fortios_system_snmp_community.rst

source:	fortios_system_snmp_community.py
orphan:

fortios_system_snmp_community -- SNMP community configuration in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) 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 v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_system_snmp_community	v6.0.0 -> latest

Parameters

• 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
• system_snmp_community - SNMP community configuration. type: dict more...

  	Supported Version Ranges
  system_snmp_community	v6.0.0 -> latest

• events - SNMP trap events. type: list choices: cpu-high, mem-low, log-full, intf-ip, vpn-tun-up, vpn-tun-down, ha-switch, ha-hb-failure, ips-signature, ips-anomaly, av-virus, av-oversize, av-pattern, av-fragmented, fm-if-change, fm-conf-change, bgp-established, bgp-backward-transition, ha-member-up, ha-member-down, ent-conf-change, av-conserve, av-bypass, av-oversize-passed, av-oversize-blocked, ips-pkg-update, ips-fail-open, faz-disconnect, faz, wc-ap-up, wc-ap-down, fswctl-session-up, fswctl-session-down, load-balance-real-server-down, device-new, per-cpu-high, dhcp, pool-usage, ospf-nbr-state-change, ospf-virtnbr-state-change, temperature-high, voltage-alert, power-supply-failure, fan-failure more...

  	Supported Version Ranges
  events	v6.0.0 -> latest
  [cpu-high]	v6.0.0 -> latest
  [mem-low]	v6.0.0 -> latest
  [log-full]	v6.0.0 -> latest
  [intf-ip]	v6.0.0 -> latest
  [vpn-tun-up]	v6.0.0 -> latest
  [vpn-tun-down]	v6.0.0 -> latest
  [ha-switch]	v6.0.0 -> latest
  [ha-hb-failure]	v6.0.0 -> latest
  [ips-signature]	v6.0.0 -> latest
  [ips-anomaly]	v6.0.0 -> latest
  [av-virus]	v6.0.0 -> latest
  [av-oversize]	v6.0.0 -> latest
  [av-pattern]	v6.0.0 -> latest
  [av-fragmented]	v6.0.0 -> latest
  [fm-if-change]	v6.0.0 -> latest
  [fm-conf-change]	v6.0.0 -> latest
  [bgp-established]	v6.0.0 -> latest
  [bgp-backward-transition]	v6.0.0 -> latest
  [ha-member-up]	v6.0.0 -> latest
  [ha-member-down]	v6.0.0 -> latest
  [ent-conf-change]	v6.0.0 -> latest
  [av-conserve]	v6.0.0 -> latest
  [av-bypass]	v6.0.0 -> latest
  [av-oversize-passed]	v6.0.0 -> latest
  [av-oversize-blocked]	v6.0.0 -> latest
  [ips-pkg-update]	v6.0.0 -> latest
  [ips-fail-open]	v6.0.0 -> latest
  [faz-disconnect]	v6.0.0 -> latest
  [faz]	v7.4.1 -> latest
  [wc-ap-up]	v6.0.0 -> latest
  [wc-ap-down]	v6.0.0 -> latest
  [fswctl-session-up]	v6.0.0 -> latest
  [fswctl-session-down]	v6.0.0 -> latest
  [load-balance-real-server-down]	v6.0.0 -> latest
  [device-new]	v6.0.0 -> latest
  [per-cpu-high]	v6.0.0 -> latest
  [dhcp]	v6.4.0 -> latest
  [pool-usage]	v7.0.6 -> v7.0.12	v7.2.1 -> latest
  [ospf-nbr-state-change]	v7.0.0 -> latest
  [ospf-virtnbr-state-change]	v7.0.0 -> latest
  [temperature-high]	v6.0.0 -> latest
  [voltage-alert]	v6.0.0 -> latest
  [power-supply-failure]	v6.0.0 -> latest
  [fan-failure]	v6.0.0 -> latest

• hosts - Configure IPv4 SNMP managers (hosts). type: list member_path: hosts:id more...

  	Supported Version Ranges
  hosts	v6.0.0 -> latest

• ha_direct - Enable/disable direct management of HA cluster members. type: str choices: enable, disable more...

  	Supported Version Ranges
  ha_direct	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• host_type - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. No traps will be sent when IP type is subnet. type: str choices: any, query, trap more...

  	Supported Version Ranges
  host_type	v6.0.0 -> latest
  [any]	v6.0.0 -> latest
  [query]	v6.0.0 -> latest
  [trap]	v6.0.0 -> latest

• id - Host entry ID. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> latest

• ip - IPv4 address of the SNMP manager (host). type: str more...

  	Supported Version Ranges
  ip	v6.0.0 -> latest

• source_ip - Source IPv4 address for SNMP traps. type: str more...

  	Supported Version Ranges
  source_ip	v6.0.0 -> latest

• hosts6 - Configure IPv6 SNMP managers. type: list member_path: hosts6:id more...

  	Supported Version Ranges
  hosts6	v6.0.0 -> latest

• ha_direct - Enable/disable direct management of HA cluster members. type: str choices: enable, disable more...

  	Supported Version Ranges
  ha_direct	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• host_type - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. type: str choices: any, query, trap more...

  	Supported Version Ranges
  host_type	v6.0.0 -> latest
  [any]	v6.0.0 -> latest
  [query]	v6.0.0 -> latest
  [trap]	v6.0.0 -> latest

• id - Host6 entry ID. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> latest

• ipv6 - SNMP manager IPv6 address prefix. type: str more...

  	Supported Version Ranges
  ipv6	v6.0.0 -> latest

• source_ipv6 - Source IPv6 address for SNMP traps. type: str more...

  	Supported Version Ranges
  source_ipv6	v6.0.0 -> latest

• id - Community ID. see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> latest

• mib_view - SNMP access control MIB view. Source system.snmp.mib-view.name. type: str more...

  	Supported Version Ranges
  mib_view	v7.2.0 -> latest

• name - Community name. type: str more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• query_v1_port - SNMP v1 query port . type: int more...

  	Supported Version Ranges
  query_v1_port	v6.0.0 -> latest

• query_v1_status - Enable/disable SNMP v1 queries. type: str choices: enable, disable more...

  	Supported Version Ranges
  query_v1_status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• query_v2c_port - SNMP v2c query port . type: int more...

  	Supported Version Ranges
  query_v2c_port	v6.0.0 -> latest

• query_v2c_status - Enable/disable SNMP v2c queries. type: str choices: enable, disable more...

  	Supported Version Ranges
  query_v2c_status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• status - Enable/disable this SNMP community. type: str choices: enable, disable more...

  	Supported Version Ranges
  status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• trap_v1_lport - SNMP v1 trap local port . type: int more...

  	Supported Version Ranges
  trap_v1_lport	v6.0.0 -> latest

• trap_v1_rport - SNMP v1 trap remote port . type: int more...

  	Supported Version Ranges
  trap_v1_rport	v6.0.0 -> latest

• trap_v1_status - Enable/disable SNMP v1 traps. type: str choices: enable, disable more...

  	Supported Version Ranges
  trap_v1_status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• trap_v2c_lport - SNMP v2c trap local port . type: int more...

  	Supported Version Ranges
  trap_v2c_lport	v6.0.0 -> latest

• trap_v2c_rport - SNMP v2c trap remote port . type: int more...

  	Supported Version Ranges
  trap_v2c_rport	v6.0.0 -> latest

• trap_v2c_status - Enable/disable SNMP v2c traps. type: str choices: enable, disable more...

  	Supported Version Ranges
  trap_v2c_status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• vdoms - SNMP access control VDOMs. type: list member_path: vdoms:name more...

  	Supported Version Ranges
  vdoms	v7.2.0 -> latest

• name - VDOM name. Source system.vdom.name. type: str required: true more...

  	Supported Version Ranges
  name	v7.2.0 -> latest

Notes

Note

• We highly recommend using your own value as the id instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: SNMP community configuration.
  fortinet.fortios.fortios_system_snmp_community:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_snmp_community:
          events: "cpu-high"
          hosts:
              -
                  ha_direct: "enable"
                  host_type: "any"
                  id: "7"
                  ip: "<your_own_value>"
                  source_ip: "84.230.14.43"
          hosts6:
              -
                  ha_direct: "enable"
                  host_type: "any"
                  id: "13"
                  ipv6: "<your_own_value>"
                  source_ipv6: "<your_own_value>"
          id: "16"
          mib_view: "<your_own_value> (source system.snmp.mib-view.name)"
          name: "default_name_18"
          query_v1_port: "161"
          query_v1_status: "enable"
          query_v2c_port: "161"
          query_v2c_status: "enable"
          status: "enable"
          trap_v1_lport: "162"
          trap_v1_rport: "162"
          trap_v1_status: "enable"
          trap_v2c_lport: "162"
          trap_v2c_rport: "162"
          trap_v2c_status: "enable"
          vdoms:
              -
                  name: "default_name_31 (source system.vdom.name)"

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 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

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)
• Nicolas Thomas (@thomnico)

Hint

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