upsertVirtualRouter

The upsertVirtualRouter operation handles configuration related to VirtualRouter 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	Name of the VRF
isSystemDefined	True	boolean	A Boolean value, TRUE or FALSE(the default). The TRUE value indicates that this VRF object is a system defined object with name as Global Field level constraints: cannot be null. (Note: Additional constraints might exist)
description	False	string	An optional description of this VRF Field level constraints: length must be between 0 and 200 (inclusive), must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
interfaces	False	[object]	Interfaces which will operate under the specific VRF context Allowed types are: [BridgeGroupInterface, EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
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	virtualrouter

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: "interfaceId", "fts". The "fts" filter cannot be used with other filters. Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertVirtualRouter' operation
  ftd_configuration:
    operation: "upsertVirtualRouter"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        isSystemDefined: "{{ is_system_defined }}"
        description: "{{ description }}"
        interfaces: "{{ interfaces }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"