fwebos_snmp_community.py – Config FortiWeb SNMP v1/v2c Community¶
New in version 1.0.1.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.11
FortiWeb Version Compatibility¶
v7.0.x |
v7.2.x |
v7.4.x |
v7.6.x |
|
| fwebos_snmp_community.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request required: True
- id The number of community type:integer
- name community name type:string maxLength:63
- status enable/disable type:string choice: enable, disable,
- hosts allow hosts configuration type:array
- id host entry id
- ip Class A,B,C ip xxx.xxx.xxx.xxx or IPv6
- query-v1-status enable/disable snmp v1 query type:string choice: enable, disable,
- query-v1-port snmp v1 query port type:integer maximum:65535 minimum:1
- query-v2c-status enable/disable snmp v2c query type:string choice: enable, disable,
- query-v2c-port snmp v2c query port type:integer maximum:65535 minimum:1
- trap-v1-status enable/disable snmp v1 trap type:string choice: enable, disable,
- trap-v1-lport snmp v1 trap local port type:integer maximum:65535 minimum:1
- trap-v1-rport snmp v1 trap remote port type:integer maximum:65535 minimum:1
- trap-v2c-status enable/disable snmp v2c trap type:string choice: enable, disable,
- trap-v2c-lport snmp v2c trap local port type:integer maximum:65535 minimum:1
- trap-v2c-rport snmp v2c trap remote port type:integer maximum:65535 minimum:1
- events SNMP Traps type:string choice: cpu-high, mem-low, log-full, intf-ip, sys-mode-change, policy-start, policy-stop, pserver-failed, sys-ha-cluster-status-change, sys-ha-member-join, sys-ha-member-leave, waf-amethod-attack, waf-signature-detection, waf-url-access-attack, waf-pvalid-attack, waf-hidden-fields, netlink-up-status, netlink-down-status, power-supply-failure, policy-ldap-auth-failure, policy-radius-auth-failure,
- mkey If present, objects will be filtered on property with this name type:string
- vdom Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs) type:array
- clone_mkey Use *clone_mkey* to specify the ID for the new resource to be cloned. If *clone_mkey* is set, *mkey* must be provided which is cloned from. type:string
Examples¶
- name:
hosts: all
vars:
connection: httpapi
gather_facts: false
tasks:
- name: Create snmp community
fwebos_snmp_community:
action: add
id: 3
name: 166
status: enable
status_val: 1
sz_hosts: -1
query_v1_status: enable
query_vl_status_val: 1
query_vl_port: 163
query_v2c_status: enable
query_v2c_status_val: 1
query_v2c_port: 163
trap_v1_status: enable
trap_v1_status_val: 1
trap_v1_lport: 169
trap_v1_rport: 169
trap_v2c_status: enable
trap_v2c_status_val: 1
trap_v2c_lport: 162
trap_v2c_rport: 162
events: cpu-high mem-low
events_val: 0
- name: edit snmp community
fwebos_snmp_community:
action: edit
id: 3
name: 166
status: enable
status_val: 1
sz_hosts: -1
query_v1_status: enable
query_vl_status_val: 1
query_vl_port: 163
query_v2c_status: enable
query_v2c_status_val: 1
query_v2c_port: 163
trap_v1_status: enable
trap_v1_status_val: 1
trap_v1_lport: 189
trap_v1_rport: 189
trap_v2c_status: enable
- name: delete snmp community
fwebos_snmp_community:
action: delete
id: 3
name: 166
trap_v2c_status_val: 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:
- 200 : OK: Request returns successful
- 400 : Bad Request: Request cannot be processed by the API
- 401 : Not Authorized: Request without successful login session
- 403 : Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.
- 404 : Resource Not Found: Unable to find the specified resource.
- 405 : Method Not Allowed: Specified HTTP method is not allowed for this resource.
- 413 : Request Entity Too Large: Request cannot be processed due to large entity
- 424 : Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value
- 429 : Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.
- 500 : Internal Server Error: Internal error when processing the request
For errorcode please check FortiWeb API errorcode at : https://documenter.getpostman.com/view/11233300/TVetbkaK#887b9eb4-7c13-4338-a8db-16cc117f0119