upsertStaticRouteEntry

The upsertStaticRouteEntry operation handles configuration related to StaticRouteEntry 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	An optional Unicode string, from 0 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)
iface	True	object	The device interface through which traffic will be routed. The gateway address must be accessible from this interface. Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [BridgeGroupInterface, EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
networks	True	[object]	A list of destination networks for this route. Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [NetworkObject]
gateway	False	object	The address of the next hop device. Traffic will be sent to this address. Allowed types are: [NetworkObject]
metricValue	False	integer	A value between 1 and 254 that represents the administrative distance for this route. Field level constraints: must be between 1 and 255 (inclusive). (Note: Additional constraints might exist)
ipType	True	string	The IP type of the route Field level constraints: cannot be null. (Note: Additional constraints might exist)
slaMonitor	False	object	The SLA monitor Allowed types are: [SLAMonitor]
rulePosition	False	integer	Transient field holding the index position for the rule
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
parentId	True	string

Query Parameters

Parameter	Required	Type	Description
at	False	integer	An integer representing where to add the new object in the ordered list. Use 0 to add it at the beginning of the list. If not specified, it will be added at the end of the list
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 'upsertStaticRouteEntry' operation
  ftd_configuration:
    operation: "upsertStaticRouteEntry"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        iface: "{{ iface }}"
        networks: "{{ networks }}"
        gateway: "{{ gateway }}"
        metricValue: "{{ metric_value }}"
        ipType: "{{ ip_type }}"
        slaMonitor: "{{ sla_monitor }}"
        rulePosition: "{{ rule_position }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        parentId: "{{ parent_id }}"
    query_params:
        at: "{{ at }}"
        filter: "{{ filter }}"