fmgr_devprof_system_snmp_community_obj – SNMP community 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 [clone, delete, get, set, update] the following FortiManager json-rpc urls.
/pm/config/adom/{adom}/devprof/{devprof}/system/snmp/community/{community}
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
community - the object name type: str

parameters for method: [clone, set, update] - SNMP community configuration.

data - No description for the parameter type: dict
- 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, 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 - No description for the parameter type: array
  - ha-direct - Enable/disable direct management of HA cluster members. type: str choices: [disable, enable]
  - host-type - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. type: str choices: [any, query, trap]
  - id - Host entry ID. type: int
  - ip - IPv4 address of the SNMP manager (host). type: str
  - source-ip - Source IPv4 address for SNMP traps. type: str
- hosts6 - No description for the parameter type: array
  - ha-direct - Enable/disable direct management of HA cluster members. type: str choices: [disable, enable]
  - host-type - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. type: str choices: [any, query, trap]
  - id - Host6 entry ID. type: int
  - ipv6 - SNMP manager IPv6 address prefix. type: str
  - source-ipv6 - Source IPv6 address for SNMP traps. type: str
- id - Community ID. type: int
- name - Community name. type: str
- query-v1-port - SNMP v1 query port (default = 161). type: int
- query-v1-status - Enable/disable SNMP v1 queries. type: str choices: [disable, enable]
- query-v2c-port - SNMP v2c query port (default = 161). type: int
- query-v2c-status - Enable/disable SNMP v2c queries. type: str choices: [disable, enable]
- status - Enable/disable this SNMP community. type: str choices: [disable, enable]
- trap-v1-lport - SNMP v1 trap local port (default = 162). type: int
- trap-v1-rport - SNMP v1 trap remote port (default = 162). type: int
- trap-v1-status - Enable/disable SNMP v1 traps. type: str choices: [disable, enable]
- trap-v2c-lport - SNMP v2c trap local port (default = 162). type: int
- trap-v2c-rport - SNMP v2c trap remote port (default = 162). type: int
- trap-v2c-status - Enable/disable SNMP v2c traps. type: str choices: [disable, enable]

parameters for method: [delete] - SNMP community configuration.

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

option - Set fetch option for the request. type: str choices: [object member, chksum, datasrc]

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/COMMUNITY/{COMMUNITY}
     fmgr_devprof_system_snmp_community_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [clone, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           devprof: <value of string>
           community: <value of string>
        params:
           -
              data:
                 events:
                   - <value in [cpu-high, mem-low, log-full, ...]>
                 hosts:
                   -
                       ha-direct: <value in [disable, enable]>
                       host-type: <value in [any, query, trap]>
                       id: <value of integer>
                       ip: <value of string>
                       source-ip: <value of string>
                 hosts6:
                   -
                       ha-direct: <value in [disable, enable]>
                       host-type: <value in [any, query, trap]>
                       id: <value of integer>
                       ipv6: <value of string>
                       source-ipv6: <value of string>
                 id: <value of integer>
                 name: <value of string>
                 query-v1-port: <value of integer>
                 query-v1-status: <value in [disable, enable]>
                 query-v2c-port: <value of integer>
                 query-v2c-status: <value in [disable, enable]>
                 status: <value in [disable, enable]>
                 trap-v1-lport: <value of integer>
                 trap-v1-rport: <value of integer>
                 trap-v1-status: <value in [disable, enable]>
                 trap-v2c-lport: <value of integer>
                 trap-v2c-rport: <value of integer>
                 trap-v2c-status: <value in [disable, enable]>

   - name: REQUESTING /PM/CONFIG/DEVPROF/{DEVPROF}/SYSTEM/SNMP/COMMUNITY/{COMMUNITY}
     fmgr_devprof_system_snmp_community_obj:
        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>
           community: <value of string>
        params:
           -
              option: <value in [object member, chksum, datasrc]>

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: [clone, set, update]

data - No description for the parameter type: dict
- id - Community ID. type: int
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/community/{community}

return values for method: [delete]

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/community/{community}

return values for method: [get]

data - No description for the parameter type: dict
- events - No description for the parameter type: array
  - {no-name} - No description for the parameter type: str
- hosts - No description for the parameter type: array
  - ha-direct - Enable/disable direct management of HA cluster members. type: str
  - host-type - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. type: str
  - id - Host entry ID. type: int
  - ip - IPv4 address of the SNMP manager (host). type: str
  - source-ip - Source IPv4 address for SNMP traps. type: str
- hosts6 - No description for the parameter type: array
  - ha-direct - Enable/disable direct management of HA cluster members. type: str
  - host-type - Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. type: str
  - id - Host6 entry ID. type: int
  - ipv6 - SNMP manager IPv6 address prefix. type: str
  - source-ipv6 - Source IPv6 address for SNMP traps. type: str
- id - Community ID. type: int
- name - Community name. type: str
- query-v1-port - SNMP v1 query port (default = 161). type: int
- query-v1-status - Enable/disable SNMP v1 queries. type: str
- query-v2c-port - SNMP v2c query port (default = 161). type: int
- query-v2c-status - Enable/disable SNMP v2c queries. type: str
- status - Enable/disable this SNMP community. type: str
- trap-v1-lport - SNMP v1 trap local port (default = 162). type: int
- trap-v1-rport - SNMP v1 trap remote port (default = 162). type: int
- trap-v1-status - Enable/disable SNMP v1 traps. type: str
- trap-v2c-lport - SNMP v2c trap local port (default = 162). type: int
- trap-v2c-rport - SNMP v2c trap remote port (default = 162). type: int
- trap-v2c-status - Enable/disable SNMP v2c traps. 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/community/{community}

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.