upsertBGPGeneralSettings

The upsertBGPGeneralSettings operation handles configuration related to BGPGeneralSettings 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 User defined description for this object.
Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist)
asNumber True string Unique Autonomous number that enables bgp process. Valid values for autonomous number are from 1-4294967295 and 1.0-XX.YY.
Field level constraints: cannot be null, must match pattern ^(([1-9]\d{0,8}|[1-3]\d{1,9}|4([0-1]\d{8}|2([0-8]\d{7}|9([0-3]\d{6}|4([0-8]\d{5}|9([0-5]\d{4}|6([0-6]\d{3}|7([0-1]\d{2}|2([0-8]\d{1}|9[0-5]{1})))))))))$)|(^(?:(?:(6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]\d{3}|[1-5]\d{4}|[1-9]\d{1,3}|[1-9])).(?:(6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]\d{3}|[1-5]\d{4}|[1-9]\d{1,3}|\d)))$). (Note: Additional constraints might exist)
routerId False string Represents the default router ID for all the BGP routing processes.
Field level constraints: must be a valid IP address, must match pattern (?:(?:\d|[1-9]\d{1,2}|2[0-4]\d|25[0-5]).){3}(?:\d|[1-9]\d{1,2}|2[0-4]\d|25[0-5]). (Note: Additional constraints might exist)
scanTime False integer Scanning intervals of BGP routers for next hop validation. Valid values are from 5 to 60 seconds. The default is 60 seconds.
Field level constraints: must be between 5 and 60 (inclusive). (Note: Additional constraints might exist)
aggregateTimer False integer Represents interval at which BGP routes will be aggregated. Valid values are from 6 to 60 seconds. The default is 30 seconds.
Field level constraints: must be between 6 and 60 (inclusive). (Note: Additional constraints might exist)
bgpNextHopTriggerDelay False integer Sets the delay to trigger nexthop address tracking. Range is from 0 to 100. Default is 5
Field level constraints: must be between 0 and 100 (inclusive). (Note: Additional constraints might exist)
bgpNextHopTriggerEnable False boolean If true, enables BGP next-hop address tracking immediately. Default is true.
maxasLimit False integer Specifies the maximum number of Autonomous system segments allowed. Valid values are from 1 to 254.
Field level constraints: must be between 1 and 254 (inclusive). (Note: Additional constraints might exist)
logNeighborChanges True boolean Logs the neighbor status. If true, enables the logging of neighbor change messages. Default value is true.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
transportPathMtuDiscovery True boolean If true, enables BGP to automatically discover the best TCP path MTU for each BGP session. Default value is true.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
fastExternalFallOver True boolean Enable BGP to terminate external BGP sessions of any directly adjacent peer if the link used to reach the peer goes down; without waiting for the hold-down timer to expire. Default value is true.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
enforceFirstAs True boolean Allow a BGP routing process to discard updates received from an external BGP (eBGP) peers that do not list their autonomous system (AS) number as the first AS path segment in the AS_PATH attribute of the incoming route. Default value is true.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
asnotationDot True boolean Change the default display and regular expression match format of BGP 4-byte autonomous system numbers from asplain (decimal values) to dot notation. Default value is false.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
bgpTimers True object An instance of type BGPTimers that represents the configuration of timer values for this process.
Field level constraints: cannot be null. (Note: Additional constraints might exist)
bgpGracefulRestart False object An instance of type BGPGracefulRestart that enable or disable the BGP graceful restart capability for a BGP neighbor.
bgpBestPath True object An instance of type BGPBestPath that represents comparision between similar routes received from external BGP (eBGP) peers during the best path selection process and switch the best path to the route with the lowest router ID.
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.

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 'upsertBGPGeneralSettings' operation
  ftd_configuration:
    operation: "upsertBGPGeneralSettings"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        asNumber: "{{ as_number }}"
        routerId: "{{ router_id }}"
        scanTime: "{{ scan_time }}"
        aggregateTimer: "{{ aggregate_timer }}"
        bgpNextHopTriggerDelay: "{{ bgp_next_hop_trigger_delay }}"
        bgpNextHopTriggerEnable: "{{ bgp_next_hop_trigger_enable }}"
        maxasLimit: "{{ maxas_limit }}"
        logNeighborChanges: "{{ log_neighbor_changes }}"
        transportPathMtuDiscovery: "{{ transport_path_mtu_discovery }}"
        fastExternalFallOver: "{{ fast_external_fall_over }}"
        enforceFirstAs: "{{ enforce_first_as }}"
        asnotationDot: "{{ asnotation_dot }}"
        bgpTimers: "{{ bgp_timers }}"
        bgpGracefulRestart: "{{ bgp_graceful_restart }}"
        bgpBestPath: "{{ bgp_best_path }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"