addBGP

The addBGP 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
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{9}|4[0-2]\d[0-4]\d[0-6][0-7][0-2]\d[0-5]|(?:(?:[1-9]\d{0,3}|[1-5]\d{4}|6[0-5][0-5][0-3][0-5]).(?:0|[1-9]\d{0,3}|[1-5]\d{4}|6[0-5][0-5][0-3][0-5])). (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
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

Example 

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