W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_devprof_system_snmp_user module – SNMP user configuration.

Note

This module is part of the fortinet.fortimanager collection (version 2.10.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_user.

New in fortinet.fortimanager 1.0.0

Synopsis
Parameters
Notes
Examples
Return Values

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_user dictionary	The top level parameters set.
auth_proto aliases: auth-proto string	Authentication protocol. Choices: `"md5"` `"sha"` `"sha224"` `"sha256"` `"sha384"` `"sha512"`
auth_pwd aliases: auth-pwd any	(list) Password for authentication protocol.
events list / elements=string	SNMP notifications 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"` `"disk-failure"` `"disk-overload"` `"faz-main-failover"` `"faz-alt-failover"` `"slbc"` `"faz"` `"power-supply"` `"ippool"` `"interface"` `"security_level_change"` `"cert-expiry"` `"dio"`
ha_direct aliases: ha-direct string	Enable/disable direct management of HA cluster members. Choices: `"disable"` `"enable"`
interface any	(list) Specify outgoing interface to reach server.
interface_select_method aliases: interface-select-method string	Specify how to select outgoing interface to reach server. Choices: `"auto"` `"sdwan"` `"specify"`
mib_view aliases: mib-view string	SNMP access control MIB view.
name string / required	SNMP user name.
notify_hosts aliases: notify-hosts any	(list) SNMP managers to send notifications
notify_hosts6 aliases: notify-hosts6 string	IPv6 SNMP managers to send notifications
priv_proto aliases: priv-proto string	Privacy Choices: `"aes"` `"des"` `"aes256"` `"aes256cisco"`
priv_pwd aliases: priv-pwd any	(list) Password for privacy
queries string	Enable/disable SNMP queries for this user. Choices: `"disable"` `"enable"`
query_port aliases: query-port integer	SNMPv3 query port
security_level aliases: security-level string	Security level for message authentication and encryption. Choices: `"no-auth-no-priv"` `"auth-no-priv"` `"auth-priv"`
source_ip aliases: source-ip string	Source IP for SNMP trap.
source_ipv6 aliases: source-ipv6 string	Source IPv6 for SNMP trap.
status string	Enable/disable this SNMP user. Choices: `"disable"` `"enable"`
trap_lport aliases: trap-lport integer	SNMPv3 local trap port
trap_rport aliases: trap-rport integer	SNMPv3 trap remote port
trap_status aliases: trap-status string	Enable/disable traps for this SNMP user. Choices: `"disable"` `"enable"`
vdoms any	(list) SNMP access control VDOMs.
vrf_select aliases: vrf-select integer	VRF ID used for connection to server.
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
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SNMP user configuration.
      fortinet.fortimanager.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: 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 scripts
      fortinet.fortimanager.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: "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)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_devprof_system_snmp_user_module.html