fadcos_system_snmp_community – configure SNMP community settings in Fortinet’s FortiADC¶
New in version 1.1.0.
Parameters¶
- action - Type of action to perform on the object. type: str required: true
- name - Specify the name of the SNMP community.type: str required: false
- ip - Port number on which the system listens for SNMP queries from the SNMP managers in this community.type: str required: false default: 161
- query_v1_status - Enable/disable SNMP v1 queries.type: int required: false default: enable
- query_v2c_port - Port number on which the system listens for SNMP queries from the SNMP managers in this community.type: str required: false default: 161
- query_v2c_status - Enable/disable SNMP v2c queries.type: int required: false default: enable
- id - Specify id of the SNMP community.type: int required: false
- id_list - SNMP community id listtype: list required: false
Examples¶
- name:
hosts: all
vars:
connection: httpapi
gather_facts: false
tasks:
- name: add
fadcos_system_snmp_community:
action: add
name: test
query_v1_port: '161'
query_v1_status: enable
query_v2c_port: '161'
query_v2c_status: enable
- name: edit
fadcos_system_snmp_community:
action: edit
id: '1'
query_v1_port: '162'
query_v1_status: disable
query_v2c_port: '162'
query_v2c_status: disable
- name: get
fadcos_system_snmp_community:
action: get
- name: remove
fadcos_system_snmp_community:
action: remove
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/