editBGP

The editBGP operation handles configuration related to BGP 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 a fixed router ID for the local BGP routing process.
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)
addressFamilyIPv4 False object An instance of type AFIPv4 that represents the address family configuration to configure a routing session using standard IPv4 address prefixes
addressFamilyIPv6 False object An instance of type AFIPv6 that represents the address family configuration to configure a routing session using standard IPv6 address prefixes
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
vrfId True string
objId True string

Example

- name: Execute 'editBGP' operation
  ftd_configuration:
    operation: "editBGP"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        asNumber: "{{ as_number }}"
        routerId: "{{ router_id }}"
        addressFamilyIPv4: "{{ address_family_i_pv4 }}"
        addressFamilyIPv6: "{{ address_family_i_pv6 }}"
        id: "{{ id }}"
        type: "{{ type }}"
    path_params:
        vrfId: "{{ vrf_id }}"
        objId: "{{ obj_id }}"