upsertOSPF

The upsertOSPF 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
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)
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)
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

Query Parameters

Parameter	Required	Type	Description
filter	False	string	The criteria used to filter the models you are requesting. It should have the following format: {key}{operator}{value}[;{key}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported keys are: "name", "fts". The "fts" filter cannot be used with other filters. Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertOSPF' operation
  ftd_configuration:
    operation: "upsertOSPF"
    data:
        version: "{{ version }}"
        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 }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        vrfId: "{{ vrf_id }}"
    query_params:
        filter: "{{ filter }}"