fadcos_system_snmp_user_child_host – configure child host of SNMP community in Fortinet’s FortiADC¶
New in version 1.1.0.
Parameters¶
- action - Type of action to perform on the object. type: str required: true
- snmp_name - Specify the name of the SNMP community.type: str required: true
- ip - Specify a host address and mask for the SNMP manager to receive traps and be permitted to query the FortiADC system.type: str required: false default: 161
- id - Specify id of the child host.type: int required: false
- id_list - child host id listtype: list required: false
Examples¶
- name:
hosts: all
vars:
connection: httpapi
gather_facts: false
tasks:
- name: add
fadcos_system_snmp_user_child_host:
action: add
snmp_name: 'test'
ip: '172.23.133.0/24'
- name: edit
fadcos_system_snmp_user_child_host:
action: edit
snmp_name: 'test'
id: '1'
ip: '172.23.140.0/24'
- name: get
fadcos_system_snmp_user_child_host:
action: get
snmp_name: 'test'
- name: remove
fadcos_system_snmp_user_child_host:
action: remove
snmp_name: 'test'
id_list:
- '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, or 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 FortiADC API errorcode at : https://fndn.fortinet.net/index.php?/fortiapi/981-fortiadc/