/ home / fortinet / fortinet.fortimanager / 1.0.5 / module / fmgr_devprof_system_snmp_user

fortinet.fortimanager.fmgr_devprof_system_snmp_user (1.0.5) — module

SNMP user configuration.

| "added in version" 2.10 of fortinet.fortimanager"

Authors: Frank Shen (@fshen01), Link Zheng (@zhengl)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==1.0.5

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 1.0.5

Description

This module is able to configure a FortiManager device by allowing the user to [ add get set update ] the following apis.

/pm/config/adom/{adom}/devprof/{devprof}/system/snmp/user

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

Usage examples

Scanned by Steampunk Spotter

 - 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]>

Inputs

    
method:
    choices:
    - add
    - get
    - set
    - update
    description:
    - The method in request
    required: true
    type: str

params:
    description:
    - The parameters for each method
    - See full parameters list in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
    required: false
    type: list

url_params:
    description:
    - The parameters for each API request URL
    - Also see full URL parameters in https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
    required: false
    type: dict

loose_validation:
    description:
    - Do parameter validation in a loose way
    required: false
    type: bool

workspace_locking_adom:
    description:
    - the adom name to lock in case FortiManager running in workspace mode
    - it can be global or any other custom adom names
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description:
    - the maximum time in seconds to wait for other user to release the workspace lock
    required: false
    type: int

Outputs

data:
  description: The payload returned in the request
  returned: always
  type: dict
status:
  description: The status of api request
  returned: always
  type: dict
url:
  description: The full url requested
  returned: always
  sample: /sys/login/user
  type: str