addStaticRouteEntry

The addStaticRouteEntry 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
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
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

Example

- name: Execute 'addStaticRouteEntry' operation
  ftd_configuration:
    operation: "addStaticRouteEntry"
    data:
        name: "{{ name }}"
        description: "{{ description }}"
        iface: "{{ iface }}"
        networks: "{{ networks }}"
        gateway: "{{ gateway }}"
        metricValue: "{{ metric_value }}"
        ipType: "{{ ip_type }}"
        slaMonitor: "{{ sla_monitor }}"
        rulePosition: "{{ rule_position }}"
        type: "{{ type }}"
    path_params:
        parentId: "{{ parent_id }}"
    query_params:
        at: "{{ at }}"