editSNMPHost

The editSNMPHost operation handles configuration related to SNMPHost 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 object
description	False	string	An optional description of the host object. Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
managerAddress	True	object	The name of a network object that defines the IP addresses of the management stations that can access this device. You can specify up to 4000 host addresses for polling, but only 128 if you enable traps. The network objects can be IPv6 or IPv4 host objects, or IPv4 subnet or address range objects. Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [NetworkObject]
udpPort	True	integer	The trap UDP port number for the SNMP host. The default value is 162. Field level constraints: cannot be null, must be between 1 and 65535 (inclusive). (Note: Additional constraints might exist)
pollEnabled	True	boolean	A Boolean value, TRUE or FALSE, that indicates whether polling is enabled. When enabled, the management station periodically requests information from the device. SNMP Poll and Trap both cannot be FALSE. Field level constraints: cannot be null. (Note: Additional constraints might exist)
trapEnabled	True	boolean	A Boolean value, TRUE or FALSE, that indicates whether traps are enabled. When enabled, the device sends trap events to the management station as they occur. SNMP Poll and Trap both cannot be FALSE. Field level constraints: cannot be null. (Note: Additional constraints might exist)
securityConfiguration	True	object	Must have valid values complying with format specified in SNMPv3SecurityConfiguration, SNMPv2cSecurityConfiguration or SNMPv1SecurityConfiguration. Field level constraints: cannot be null. (Note: Additional constraints might exist)
interface	False	object	A name that represents a PhysicalInterface or a SubInterface or a Mgmt Interface from which traps are sent.
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 'editSNMPHost' operation
  ftd_configuration:
    operation: "editSNMPHost"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        managerAddress: "{{ manager_address }}"
        udpPort: "{{ udp_port }}"
        pollEnabled: "{{ poll_enabled }}"
        trapEnabled: "{{ trap_enabled }}"
        securityConfiguration: "{{ security_configuration }}"
        interface: "{{ interface }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"