editOSPFInterfaceSettings

The editOSPFInterfaceSettings operation handles configuration related to OSPFInterfaceSettings 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 string that represents the name of the object
description	False	string	Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
deviceInterface	True	object	The interface for which ospf settings has to be configured. The interface must not be a BVI interface, member of BVI interface, or be passive, or used in high availability configuration, and should be in enabled state Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [BridgeGroupInterface, EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
ospfProtocolConfiguration	True	object	Represents the configuration to be made for OSPF protocol Field level constraints: cannot be null. (Note: Additional constraints might exist)
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
vrfId	True	string
objId	True	string

Example

- name: Execute 'editOSPFInterfaceSettings' operation
  ftd_configuration:
    operation: "editOSPFInterfaceSettings"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        deviceInterface: "{{ device_interface }}"
        ospfProtocolConfiguration: "{{ ospf_protocol_configuration }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        vrfId: "{{ vrf_id }}"
        objId: "{{ obj_id }}"