fortinet.fortimanager.fmgr_devprof_system_snmp_community module – SNMP community configuration.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_devprof_system_snmp_community.

New in fortinet.fortimanager 1.0.0

Synopsis

  • This module is able to configure a FortiManager device.

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

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

devprof

string / required

The parameter (devprof) in requested url.

devprof_system_snmp_community

dictionary

The top level parameters set.

events

list / elements=string

SNMP trap events.

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"

hosts

list / elements=dictionary

Hosts.

ha_direct

string

Enable/disable direct management of HA cluster members.

Choices:

  • "disable"

  • "enable"

host_type

string

Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.

Choices:

  • "any"

  • "query"

  • "trap"

id

integer

Host entry ID.

interface

any

(list) Specify outgoing interface to reach server.

interface_select_method

string

Specify how to select outgoing interface to reach server.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

ip

string

IPv4 address of the SNMP manager

source_ip

string

Source IPv4 address for SNMP traps.

hosts6

list / elements=dictionary

Hosts6.

ha_direct

string

Enable/disable direct management of HA cluster members.

Choices:

  • "disable"

  • "enable"

host_type

string

Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.

Choices:

  • "any"

  • "query"

  • "trap"

id

integer

Host6 entry ID.

interface

any

(list) Specify outgoing interface to reach server.

interface_select_method

string

Specify how to select outgoing interface to reach server.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

ipv6

string

SNMP manager IPv6 address prefix.

source_ipv6

string

Source IPv6 address for SNMP traps.

id

integer / required

Community ID.

mib_view

string

SNMP access control MIB view.

name

string

Community name.

query_v1_port

integer

SNMP v1 query port

query_v1_status

string

Enable/disable SNMP v1 queries.

Choices:

  • "disable"

  • "enable"

query_v2c_port

integer

SNMP v2c query port

query_v2c_status

string

Enable/disable SNMP v2c queries.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable this SNMP community.

Choices:

  • "disable"

  • "enable"

trap_v1_lport

integer

SNMP v1 trap local port

trap_v1_rport

integer

SNMP v1 trap remote port

trap_v1_status

string

Enable/disable SNMP v1 traps.

Choices:

  • "disable"

  • "enable"

trap_v2c_lport

integer

SNMP v2c trap local port

trap_v2c_rport

integer

SNMP v2c trap remote port

trap_v2c_status

string

Enable/disable SNMP v2c traps.

Choices:

  • "disable"

  • "enable"

vdoms

any

(list) SNMP access control VDOMs.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SNMP community configuration.
      fortinet.fortimanager.fmgr_devprof_system_snmp_community:
        bypass_validation: false
        adom: ansible
        devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
        state: present
        devprof_system_snmp_community:
          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
          hosts:
            - ha-direct: enable
              host-type: any
              id: 1
          id: 1
          name: "ansible-test"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the communities in system template
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "devprof_system_snmp_community"
          params:
            adom: "ansible"
            devprof: "ansible-test" # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
            community: "your_value"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)