addStaticRouteEntry

The addStaticRouteEntry operation handles configuration related to StaticRouteEntry model.

Data Parameters

Parameter	Required	Type	Description
iface	False	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, PhysicalInterface, SubInterface]
networks	False	[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. Field level constraints: cannot be null. (Note: Additional constraints might exist) 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	False	string	The IP type of the route Field level constraints: cannot be null. (Note: Additional constraints might exist)
type	False	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

Example

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