fortinet.fortimanager.fmgr_devprof_system_snmp_user module – SNMP user configuration.

Note

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

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

New in version 2.10: of fortinet.fortimanager

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

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:

  • no ← (default)

  • yes

devprof

string / required

the parameter (devprof) in requested url

devprof_system_snmp_user

dictionary

the top level parameters set

auth-proto

string

Authentication protocol.

Choices:

  • md5

  • sha

  • sha224

  • sha256

  • sha384

  • sha512

auth-pwd

string

no description

events

list / elements=string

no description

Choices:

  • cpu-high

  • mem-low

  • log-full

  • intf-ip

  • vpn-tun-up

  • vpn-tun-down

  • ha-switch

  • fm-conf-change

  • ips-signature

  • ips-anomaly

  • temperature-high

  • voltage-alert

  • av-virus

  • av-oversize

  • av-pattern

  • av-fragmented

  • ha-hb-failure

  • fan-failure

  • ha-member-up

  • ha-member-down

  • ent-conf-change

  • av-conserve

  • av-bypass

  • av-oversize-passed

  • av-oversize-blocked

  • ips-pkg-update

  • fm-if-change

  • power-supply-failure

  • amc-bypass

  • faz-disconnect

  • 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

ha-direct

string

Enable/disable direct management of HA cluster members.

Choices:

  • disable

  • enable

name

string

SNMP user name.

notify-hosts

string

no description

notify-hosts6

string

IPv6 SNMP managers to send notifications (traps) to.

priv-proto

string

Privacy (encryption) protocol.

Choices:

  • aes

  • des

  • aes256

  • aes256cisco

priv-pwd

string

no description

queries

string

Enable/disable SNMP queries for this user.

Choices:

  • disable

  • enable

query-port

integer

SNMPv3 query port (default = 161).

security-level

string

Security level for message authentication and encryption.

Choices:

  • no-auth-no-priv

  • auth-no-priv

  • auth-priv

source-ip

string

Source IP for SNMP trap.

source-ipv6

string

Source IPv6 for SNMP trap.

status

string

Enable/disable this SNMP user.

Choices:

  • disable

  • enable

trap-lport

integer

SNMPv3 local trap port (default = 162).

trap-rport

integer

SNMPv3 trap remote port (default = 162).

trap-status

string

Enable/disable traps for this SNMP user.

Choices:

  • disable

  • enable

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

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

rc_succeeded

list / elements=string

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

  • 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

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: SNMP user configuration.
     fmgr_devprof_system_snmp_user:
        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_user:
           auth-proto: md5
           auth-pwd: 'fortinet'
           events:
             - cpu-high
             - mem-low
             - log-full
             - intf-ip
             - vpn-tun-up
             - vpn-tun-down
             - ha-switch
             - fm-conf-change
             - ips-signature
             - ips-anomaly
             - temperature-high
             - voltage-alert
             - av-virus
             - av-oversize
             - av-pattern
             - av-fragmented
             - ha-hb-failure
             - fan-failure
             - ha-member-up
             - ha-member-down
             - ent-conf-change
             - av-conserve
             - av-bypass
             - av-oversize-passed
             - av-oversize-blocked
             - ips-pkg-update
             - fm-if-change
             - power-supply-failure
             - amc-bypass
             - faz-disconnect
             - 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
           ha-direct: disable
           name: 'ansible-test'

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the scripts
     fmgr_fact:
       facts:
           selector: 'devprof_system_snmp_user'
           params:
               adom: 'ansible'
               devprof: 'ansible-test' # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
               user: ''

Return Values

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

Key

Description

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_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)