fmgd_system_snmp_community – SNMP community configuration.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • system_snmp_community - SNMP community configuration. type: dict
    • 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, temperature-high, voltage-alert, ha-member-up, ha-member-down, ent-conf-change, av-conserve, av-bypass, av-oversize-passed, av-oversize-blocked, ips-pkg-update, power-supply-failure, amc-bypass, faz-disconnect, fan-failure, bgp-established, bgp-backward-transition, wc-ap-up, wc-ap-down, fswctl-session-up, fswctl-session-down, ips-fail-open, load-balance-real-server-down, device-new, enter-intf-bypass, exit-intf-bypass, per-cpu-high, power-blade-down, confsync_failure, dhcp, pool-usage, power-redundancy-degrade, power-redundancy-failure, ospf-nbr-state-change, ospf-virtnbr-state-change, disk-failure, disk-overload, faz-main-failover, faz-alt-failover, slbc, faz, power-supply, ippool, interface, security_level_change, cert-expiry, dio, sensor, bfd] more...
    • hosts Hosts. type: list more...
      • ha_direct (Alias name: ha-direct) Enable/disable direct management of ha cluster members. type: str choices: [disable, enable] more...
      • host_type (Alias name: host-type) Control whether the snmp manager sends snmp queries, receives snmp traps, or both. type: str choices: [any, query, trap] more...
      • id Host entry id. type: int more...
      • ip Ipv4 address of the snmp manager (host). type: list more...
      • source_ip (Alias name: source-ip) Source ipv4 address for snmp traps. type: str more...
      • interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
      • interface Specify outgoing interface to reach server. type: list more...
      • vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int more...
    • hosts6 Hosts6. type: list more...
      • ha_direct (Alias name: ha-direct) Enable/disable direct management of ha cluster members. type: str choices: [disable, enable] more...
      • host_type (Alias name: host-type) Control whether the snmp manager sends snmp queries, receives snmp traps, or both. type: str choices: [any, query, trap] more...
      • id Host6 entry id. type: int more...
      • ipv6 Snmp manager ipv6 address prefix. type: str more...
      • source_ipv6 (Alias name: source-ipv6) Source ipv6 address for snmp traps. type: str more...
      • interface Specify outgoing interface to reach server. type: list more...
      • interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
      • vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int more...
    • id Community id. type: int more...
    • mib_view (Alias name: mib-view) Snmp access control mib view. type: list more...
    • name Community name. type: str more...
    • query_v1_port (Alias name: query-v1-port) Snmp v1 query port (default = 161). type: int more...
    • query_v1_status (Alias name: query-v1-status) Enable/disable snmp v1 queries. type: str choices: [disable, enable] more...
    • query_v2c_port (Alias name: query-v2c-port) Snmp v2c query port (default = 161). type: int more...
    • query_v2c_status (Alias name: query-v2c-status) Enable/disable snmp v2c queries. type: str choices: [disable, enable] more...
    • status Enable/disable this snmp community. type: str choices: [disable, enable] more...
    • trap_v1_lport (Alias name: trap-v1-lport) Snmp v1 trap local port (default = 162). type: int more...
    • trap_v1_rport (Alias name: trap-v1-rport) Snmp v1 trap remote port (default = 162). type: int more...
    • trap_v1_status (Alias name: trap-v1-status) Enable/disable snmp v1 traps. type: str choices: [disable, enable] more...
    • trap_v2c_lport (Alias name: trap-v2c-lport) Snmp v2c trap local port (default = 162). type: int more...
    • trap_v2c_rport (Alias name: trap-v2c-rport) Snmp v2c trap remote port (default = 162). type: int more...
    • trap_v2c_status (Alias name: trap-v2c-status) Enable/disable snmp v2c traps. type: str choices: [disable, enable] more...
    • vdoms Snmp access control vdoms. type: list more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SNMP community configuration.
      fortinet.fmgdevice.fmgd_system_snmp_community:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        state: present # <value in [present, absent]>
        system_snmp_community:
          id: 0 # Required variable, integer
          # events:
          #   - "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"
          #   - "temperature-high"
          #   - "voltage-alert"
          #   - "ha-member-up"
          #   - "ha-member-down"
          #   - "ent-conf-change"
          #   - "av-conserve"
          #   - "av-bypass"
          #   - "av-oversize-passed"
          #   - "av-oversize-blocked"
          #   - "ips-pkg-update"
          #   - "power-supply-failure"
          #   - "amc-bypass"
          #   - "faz-disconnect"
          #   - "fan-failure"
          #   - "bgp-established"
          #   - "bgp-backward-transition"
          #   - "wc-ap-up"
          #   - "wc-ap-down"
          #   - "fswctl-session-up"
          #   - "fswctl-session-down"
          #   - "ips-fail-open"
          #   - "load-balance-real-server-down"
          #   - "device-new"
          #   - "enter-intf-bypass"
          #   - "exit-intf-bypass"
          #   - "per-cpu-high"
          #   - "power-blade-down"
          #   - "confsync_failure"
          #   - "dhcp"
          #   - "pool-usage"
          #   - "power-redundancy-degrade"
          #   - "power-redundancy-failure"
          #   - "ospf-nbr-state-change"
          #   - "ospf-virtnbr-state-change"
          #   - "disk-failure"
          #   - "disk-overload"
          #   - "faz-main-failover"
          #   - "faz-alt-failover"
          #   - "slbc"
          #   - "faz"
          #   - "power-supply"
          #   - "ippool"
          #   - "interface"
          #   - "security_level_change"
          #   - "cert-expiry"
          #   - "dio"
          #   - "sensor"
          #   - "bfd"
          # hosts:
          #   - ha_direct: <value in [disable, enable]>
          #     host_type: <value in [any, query, trap]>
          #     id: <integer>
          #     ip: <list or string>
          #     source_ip: <string>
          #     interface_select_method: <value in [auto, sdwan, specify]>
          #     interface: <list or string>
          #     vrf_select: <integer>
          # hosts6:
          #   - ha_direct: <value in [disable, enable]>
          #     host_type: <value in [any, query, trap]>
          #     id: <integer>
          #     ipv6: <string>
          #     source_ipv6: <string>
          #     interface: <list or string>
          #     interface_select_method: <value in [auto, sdwan, specify]>
          #     vrf_select: <integer>
          # mib_view: <list or string>
          # name: <string>
          # query_v1_port: <integer>
          # query_v1_status: <value in [disable, enable]>
          # query_v2c_port: <integer>
          # query_v2c_status: <value in [disable, enable]>
          # status: <value in [disable, enable]>
          # trap_v1_lport: <integer>
          # trap_v1_rport: <integer>
          # trap_v1_status: <value in [disable, enable]>
          # trap_v2c_lport: <integer>
          # trap_v2c_rport: <integer>
          # trap_v2c_status: <value in [disable, enable]>
          # vdoms: <list or string>

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)