addOSPF

The addOSPF operation handles configuration related to OSPF 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)
processId	True	string	An identifier for the OSPF Process. Must be in the range 1 - 65535 inclusive. 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)
logAdjacencyChanges	False	object	Represents the way adjacency changes must be logged. If null, disables logging for this process
processConfiguration	True	object	Represents the advanced configuration for this process Field level constraints: cannot be null. (Note: Additional constraints might exist)
areas	True	[object]	Represents the areas to be configured for this process Field level constraints: cannot be null. (Note: Additional constraints might exist)
neighbors	True	[object]	Represents the neighbors to be configured for this process Field level constraints: cannot be null. (Note: Additional constraints might exist)
summaryAddresses	True	[object]	Represents the summary addresses configured for route summarization when redistributing routes into this process. Each object represents the configuration of the advertisement on one summary route for all redistributed routes included for a network address and mask. Use AreaRange under Area to configure route summarization between OSPF areas Field level constraints: cannot be null. (Note: Additional constraints might exist)
filterRules	True	[object]	Represents the configuration of filtering incoming or outgoing routes using access control lists Field level constraints: cannot be null. (Note: Additional constraints might exist)
redistributeProtocols	True	[object]	Represents the configuration of a list of protocols whose routes are redistributed into this process Field level constraints: cannot be null. (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 'addOSPF' operation
  ftd_configuration:
    operation: "addOSPF"
    data:
        name: "{{ name }}"
        description: "{{ description }}"
        processId: "{{ process_id }}"
        logAdjacencyChanges: "{{ log_adjacency_changes }}"
        processConfiguration: "{{ process_configuration }}"
        areas: "{{ areas }}"
        neighbors: "{{ neighbors }}"
        summaryAddresses: "{{ summary_addresses }}"
        filterRules: "{{ filter_rules }}"
        redistributeProtocols: "{{ redistribute_protocols }}"
        type: "{{ type }}"
    path_params:
        vrfId: "{{ vrf_id }}"