editSNMPServer

The editSNMPServer operation handles configuration related to SNMPServer model.

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter	Required	Type	Description
version	False	string	A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name	True	string	Name of the SNMP server.
enabled	False	boolean	An Boolean value, TRUE or FALSE, that indicates whether the SNMP server is enabled on the device. The default is enabled, TRUE.
location	False	string	An optional string that describes the location of the device, for example, Building 42,Sector 54. This string is case-sensitive. Spaces are accepted. Field level constraints: length must be between 0 and 233 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
contact	False	string	The name of the device administrator or other contact person. This string is case-sensitive. Spaces are accepted. Field level constraints: length must be between 0 and 234 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
community	True	string	The global read community string, which is the password used by a SNMP management station when sending requests to the device. The SNMP community string is a shared secret among the SNMP management stations and the network nodes being managed. The security device uses the password to determine if the incoming SNMP request is valid. The password is a case-sensitive alphanumeric string of up to 32 characters; spaces and special characters are not permitted. Field level constraints: cannot be null. (Note: Additional constraints might exist)
listenPort	False	integer	The UDP port on which incoming SNMP requests will be accepted. The default is 161. Field level constraints: must be between 1 and 65535 (inclusive). (Note: Additional constraints might exist)
traps	False	[object]	An optional list enum values of the enabled traps. If this list is null, no traps are sent, even if you enable traps for an SNMP host. SNMP traps are event notifications for the FTD device. Traps are different from polling, they are unsolicited comments from the FTD device to the management station for certain events, such as linkup, linkdown, and syslog event generated. Some traps are not applicable to certain hardware models. These traps will be ignored if you apply the policy to one of these models. For example, virtual platforms do not have field-replaceable units, so the Field Replaceable Unit Insert/Delete/Config Change traps will not be configured on those models. The list can contain any or all of following enum values: SYSLOG, SNMP_AUTHENTICATION, SNMP_LINKUP, SNMP_LINKDOWN, SNMP_COLDSTART, SNMP_WARMSTART, CONNECTION_LIMIT_REACHED, NAT_PACKET_DISCARD, CPU_THRESHOLD_RISING, MEM_THRESHOLD, FAILOVER, CLUSTER, FRU_INSERT, FRU_REMOVE, CONFIG_CHANGE, PEER_FLAP.
id	False	string	A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type	True	string	A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Path Parameters

Parameter	Required	Type	Description
objId	True	string

Example

- name: Execute 'editSNMPServer' operation
  ftd_configuration:
    operation: "editSNMPServer"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        enabled: "{{ enabled }}"
        location: "{{ location }}"
        contact: "{{ contact }}"
        community: "{{ community }}"
        listenPort: "{{ listen_port }}"
        traps: "{{ traps }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"