editICMPv4PortObject

The editICMPv4PortObject operation handles configuration related to ICMPv4PortObject 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	A mandatory unicode alphanumeric string containing a unique name for the Port Object, from 1 to 128 characters without spaces. The string cannot include HTML tag. The check for duplicates is performed with a case insensitive search.
description	False	string	An optional unicode alphanumeric string containing a description of the Port Object, up to 200 characters. The string cannot include HTML tags Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
isSystemDefined	False	boolean	A Boolean value, TRUE or FALSE (the default). The TRUE value indicates that this object is a system defined object
icmpv4Type	True	string	An enum value that specifies the ICMPv4 type. Field level constraints: cannot be null. (Note: Additional constraints might exist)
icmpv4Code	False	string	An enum value that specifies the ICMPv4 code.
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 'editICMPv4PortObject' operation
  ftd_configuration:
    operation: "editICMPv4PortObject"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        isSystemDefined: "{{ is_system_defined }}"
        icmpv4Type: "{{ icmpv4_type }}"
        icmpv4Code: "{{ icmpv4_code }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"