fmgr_devprof_system_snmp_user – SNMP user configuration.¶

New in version 2.10.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status
Authors

Synopsis ¶

This module is able to configure a FortiManager device by allowing the user to [add, get, set, update] the following FortiManager json-rpc urls.
/pm/config/adom/{adom}/devprof/{devprof}/system/snmp/user
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v6.0.0

Requirements ¶

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

ansible>=2.10.0

Parameters ¶

loose_validation - Do parameter validation in a loose way type: bool required: false default: false
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom dom
workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
url_params - parameters in url path type: dict required: true

adom - the domain prefix type: str choices: none, global, custom dom
devprof - the object name type: str

parameters for method: [add, set, update] - SNMP user configuration.

data - No description for the parameter type: array
- auth-proto - Authentication protocol. type: str choices: [md5, sha]
- auth-pwd - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str
- events - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str 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]
- ha-direct - Enable/disable direct management of HA cluster members. type: str choices: [disable, enable]
- name - SNMP user name. type: str
- notify-hosts - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str
- notify-hosts6 - IPv6 SNMP managers to send notifications (traps) to. type: str
- priv-proto - Privacy (encryption) protocol. type: str choices: [aes, des, aes256, aes256cisco]
- priv-pwd - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str
- queries - Enable/disable SNMP queries for this user. type: str choices: [disable, enable]
- query-port - SNMPv3 query port (default = 161). type: int
- security-level - Security level for message authentication and encryption. type: str choices: [no-auth-no-priv, auth-no-priv, auth-priv]
- source-ip - Source IP for SNMP trap. type: str
- source-ipv6 - Source IPv6 for SNMP trap. type: str
- status - Enable/disable this SNMP user. type: str choices: [disable, enable]
- trap-lport - SNMPv3 local trap port (default = 162). type: int
- trap-rport - SNMPv3 trap remote port (default = 162). type: int
- trap-status - Enable/disable traps for this SNMP user. type: str choices: [disable, enable]

parameters for method: [get] - SNMP user configuration.

attr - The name of the attribute to retrieve its datasource. type: str
fields - No description for the parameter type: array
- {no-name} - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str choices: [auth-proto, auth-pwd, events, ha-direct, name, notify-hosts, notify-hosts6, priv-proto, priv-pwd, queries, query-port, security-level, source-ip, source-ipv6, status, trap-lport, trap-rport, trap-status]
filter - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
get used - No description for the parameter type: int
loadsub - Enable or disable the return of any sub-objects. type: int
option - Set fetch option for the request. type: str choices: [count, object member, datasrc, get reserved, syntax]
range - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
sortings - No description for the parameter type: array
- {attr_name} - No description for the parameter type: int choices: [1, -1]

Notes ¶

Note

The module may supports multiple method, every method has different parameters definition
One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
The module may include domain dependent urls, the domain can be specified in url_params as adom
To run in workspace mode, the paremeter workspace_locking_adom must be included in the task

Examples ¶

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:

   - name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/SNMP/USER
     fmgr_devprof_system_snmp_user:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           devprof: <value of string>
        params:
           -
              data:
                -
                    auth-proto: <value in [md5, sha]>
                    auth-pwd:
                      - <value of string>
                    events:
                      - <value in [cpu-high, mem-low, log-full, ...]>
                    ha-direct: <value in [disable, enable]>
                    name: <value of string>
                    notify-hosts:
                      - <value of string>
                    notify-hosts6: <value of string>
                    priv-proto: <value in [aes, des, aes256, ...]>
                    priv-pwd:
                      - <value of string>
                    queries: <value in [disable, enable]>
                    query-port: <value of integer>
                    security-level: <value in [no-auth-no-priv, auth-no-priv, auth-priv]>
                    source-ip: <value of string>
                    source-ipv6: <value of string>
                    status: <value in [disable, enable]>
                    trap-lport: <value of integer>
                    trap-rport: <value of integer>
                    trap-status: <value in [disable, enable]>

   - name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/SNMP/USER
     fmgr_devprof_system_snmp_user:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        url_params:
           adom: <value in [none, global, custom dom]>
           devprof: <value of string>
        params:
           -
              attr: <value of string>
              fields:
                -
                   - <value in [auth-proto, auth-pwd, events, ...]>
              filter:
                - <value of string>
              get used: <value of integer>
              loadsub: <value of integer>
              option: <value in [count, object member, datasrc, ...]>
              range:
                - <value of integer>
              sortings:
                -
                    varidic.attr_name: <value in [1, -1]>

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:

return values for method: [add, set, update]

status - No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
url - No description for the parameter type: str example: /pm/config/adom/{adom}/devprof/{devprof}/system/snmp/user

return values for method: [get]

data - No description for the parameter type: array
- auth-proto - Authentication protocol. type: str
- auth-pwd - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str
- events - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str
- ha-direct - Enable/disable direct management of HA cluster members. type: str
- name - SNMP user name. type: str
- notify-hosts - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str
- notify-hosts6 - IPv6 SNMP managers to send notifications (traps) to. type: str
- priv-proto - Privacy (encryption) protocol. type: str
- priv-pwd - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str
- queries - Enable/disable SNMP queries for this user. type: str
- query-port - SNMPv3 query port (default = 161). type: int
- security-level - Security level for message authentication and encryption. type: str
- source-ip - Source IP for SNMP trap. type: str
- source-ipv6 - Source IPv6 for SNMP trap. type: str
- status - Enable/disable this SNMP user. type: str
- trap-lport - SNMPv3 local trap port (default = 162). type: int
- trap-rport - SNMPv3 trap remote port (default = 162). type: int
- trap-status - Enable/disable traps for this SNMP user. type: str
status - No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
url - No description for the parameter type: str example: /pm/config/adom/{adom}/devprof/{devprof}/system/snmp/user

Status ¶

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

Authors ¶

Frank Shen (@fshen01)
Link Zheng (@zhengl)

Hint

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