fwebos_snmp_sysinfo.py – Config FortiWeb SNMP system info¶
New in version 1.0.1.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.11
Parameters¶
- body Possible parameters to go in the body for the request required: True
- status enable/disable type:string choice: enable, disable,
- engine-id Local SNMP engineID string (maximum 24 characters). type:string maxLength:63
- description description type:string maxLength:63
- contact-info contact information type:string maxLength:63
- location location type:string maxLength:63
- 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
- move_flag If supported, a flag can be specified. When *move_flag* is set, extra parameters (*move_mkey*, *sub_mkey*) must be provided. __*Note:*__ If this parameter is provided when not supported, the action will be ignored and an “invalid request” error will be returned. type:string
- sub_mkey specific resource to be moved type:string
- move_mkey specific resource to be moved before or after type:string
Examples¶
- name:
hosts: all
vars:
connection: httpapi
gather_facts: false
tasks:
- name: edit snmp sysinfo
fwebos_snmp_sysinfo:
action: edit
status: enable
description: test
contact_info: test1
location: test2
- name: edit snmp sysinfo
fwebos_snmp_sysinfo:
action: edit
status: disable
description: test
contact_info: test1
location: test2
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