addEIGRP

The addEIGRP operation handles configuration related to EIGRP model. 

Description

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

Data Parameters

Parameter Required Type Description
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)
processConfiguration True object An object of type EIGRP process configuration that represents advanced configuration for this process.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
defaultRouteDistributionIn False object An object of type standard access list that accepts input default routing information.
Allowed types are: [StandardAccessList]
defaultRouteDistributionOut False object An object of type standard access list that accepts output default routing information.
Allowed types are: [StandardAccessList]
distributionList True [object] An object of type EIGRP distribution list that represents the configuration of filtering incoming or outgoing routes using access control lists.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
routingInterfaces False object An object of type EIGRP routing interfaces to suppress routing information on the listed interfaces.
neighbors True [object] A list of objects of type EIGRP neighbor to configure the neighbor interfaces and IPv4 address to be configured for the process.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
networks True [object] A list of network objects that accepts IPv4 addresses to enable routing.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
Allowed types are: [NetworkObject]
redistributeProtocols True [object] A list of objects or type EIGRP redistribute protocol that represents the redistributed routes.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
autonomousSystemNumber True string Identifier for the EIGRP Process.
Field level constraints: cannot be null, must match pattern \d|[1-9]\d+, must be between 1 and 65535 (inclusive). (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

Example

- name: Execute 'addEIGRP' operation
  ftd_configuration:
    operation: "addEIGRP"
    data:
        name: "{{ name }}"
        description: "{{ description }}"
        processConfiguration: "{{ process_configuration }}"
        defaultRouteDistributionIn: "{{ default_route_distribution_in }}"
        defaultRouteDistributionOut: "{{ default_route_distribution_out }}"
        distributionList: "{{ distribution_list }}"
        routingInterfaces: "{{ routing_interfaces }}"
        neighbors: "{{ neighbors }}"
        networks: "{{ networks }}"
        redistributeProtocols: "{{ redistribute_protocols }}"
        autonomousSystemNumber: "{{ autonomous_system_number }}"
        type: "{{ type }}"
    path_params:
        vrfId: "{{ vrf_id }}"