fortios_router_bgp – Configure BGP in Fortinet’s FortiOS and FortiGate

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• This module is able to configure a FortiGate or FortiOS by allowing the user to set and modify router feature and bgp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

The below requirements are needed on the host that executes this module.

• fortiosapi>=0.9.8

Parameters

Notes

Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure BGP.
    fortios_router_bgp:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      router_bgp:
        admin-distance:
         -
            distance: "4"
            id:  "5"
            neighbour-prefix: "<your_own_value>"
            route-list: "<your_own_value> (source router.access-list.name)"
        aggregate-address:
         -
            as-set: "enable"
            id:  "10"
            prefix: "<your_own_value>"
            summary-only: "enable"
        aggregate-address6:
         -
            as-set: "enable"
            id:  "15"
            prefix6: "<your_own_value>"
            summary-only: "enable"
        always-compare-med: "enable"
        as: "19"
        bestpath-as-path-ignore: "enable"
        bestpath-cmp-confed-aspath: "enable"
        bestpath-cmp-routerid: "enable"
        bestpath-med-confed: "enable"
        bestpath-med-missing-as-worst: "enable"
        client-to-client-reflection: "enable"
        cluster-id: "<your_own_value>"
        confederation-identifier: "27"
        confederation-peers:
         -
            peer: "<your_own_value>"
        dampening: "enable"
        dampening-max-suppress-time: "31"
        dampening-reachability-half-life: "32"
        dampening-reuse: "33"
        dampening-route-map: "<your_own_value> (source router.route-map.name)"
        dampening-suppress: "35"
        dampening-unreachability-half-life: "36"
        default-local-preference: "37"
        deterministic-med: "enable"
        distance-external: "39"
        distance-internal: "40"
        distance-local: "41"
        ebgp-multipath: "enable"
        enforce-first-as: "enable"
        fast-external-failover: "enable"
        graceful-end-on-timer: "enable"
        graceful-restart: "enable"
        graceful-restart-time: "47"
        graceful-stalepath-time: "48"
        graceful-update-delay: "49"
        holdtime-timer: "50"
        ibgp-multipath: "enable"
        ignore-optional-capability: "enable"
        keepalive-timer: "53"
        log-neighbour-changes: "enable"
        neighbor:
         -
            activate: "enable"
            activate6: "enable"
            advertisement-interval: "58"
            allowas-in: "59"
            allowas-in-enable: "enable"
            allowas-in-enable6: "enable"
            allowas-in6: "62"
            as-override: "enable"
            as-override6: "enable"
            attribute-unchanged: "as-path"
            attribute-unchanged6: "as-path"
            bfd: "enable"
            capability-default-originate: "enable"
            capability-default-originate6: "enable"
            capability-dynamic: "enable"
            capability-graceful-restart: "enable"
            capability-graceful-restart6: "enable"
            capability-orf: "none"
            capability-orf6: "none"
            capability-route-refresh: "enable"
            conditional-advertise:
             -
                advertise-routemap: "<your_own_value> (source router.route-map.name)"
                condition-routemap: "<your_own_value> (source router.route-map.name)"
                condition-type: "exist"
            connect-timer: "80"
            default-originate-routemap: "<your_own_value> (source router.route-map.name)"
            default-originate-routemap6: "<your_own_value> (source router.route-map.name)"
            description: "<your_own_value>"
            distribute-list-in: "<your_own_value> (source router.access-list.name)"
            distribute-list-in6: "<your_own_value> (source router.access-list6.name)"
            distribute-list-out: "<your_own_value> (source router.access-list.name)"
            distribute-list-out6: "<your_own_value> (source router.access-list6.name)"
            dont-capability-negotiate: "enable"
            ebgp-enforce-multihop: "enable"
            ebgp-multihop-ttl: "90"
            filter-list-in: "<your_own_value> (source router.aspath-list.name)"
            filter-list-in6: "<your_own_value> (source router.aspath-list.name)"
            filter-list-out: "<your_own_value> (source router.aspath-list.name)"
            filter-list-out6: "<your_own_value> (source router.aspath-list.name)"
            holdtime-timer: "95"
            interface: "<your_own_value> (source system.interface.name)"
            ip: "<your_own_value>"
            keep-alive-timer: "98"
            link-down-failover: "enable"
            local-as: "100"
            local-as-no-prepend: "enable"
            local-as-replace-as: "enable"
            maximum-prefix: "103"
            maximum-prefix-threshold: "104"
            maximum-prefix-threshold6: "105"
            maximum-prefix-warning-only: "enable"
            maximum-prefix-warning-only6: "enable"
            maximum-prefix6: "108"
            next-hop-self: "enable"
            next-hop-self6: "enable"
            override-capability: "enable"
            passive: "enable"
            password: "<your_own_value>"
            prefix-list-in: "<your_own_value> (source router.prefix-list.name)"
            prefix-list-in6: "<your_own_value> (source router.prefix-list6.name)"
            prefix-list-out: "<your_own_value> (source router.prefix-list.name)"
            prefix-list-out6: "<your_own_value> (source router.prefix-list6.name)"
            remote-as: "118"
            remove-private-as: "enable"
            remove-private-as6: "enable"
            restart-time: "121"
            retain-stale-time: "122"
            route-map-in: "<your_own_value> (source router.route-map.name)"
            route-map-in6: "<your_own_value> (source router.route-map.name)"
            route-map-out: "<your_own_value> (source router.route-map.name)"
            route-map-out6: "<your_own_value> (source router.route-map.name)"
            route-reflector-client: "enable"
            route-reflector-client6: "enable"
            route-server-client: "enable"
            route-server-client6: "enable"
            send-community: "standard"
            send-community6: "standard"
            shutdown: "enable"
            soft-reconfiguration: "enable"
            soft-reconfiguration6: "enable"
            stale-route: "enable"
            strict-capability-match: "enable"
            unsuppress-map: "<your_own_value> (source router.route-map.name)"
            unsuppress-map6: "<your_own_value> (source router.route-map.name)"
            update-source: "<your_own_value> (source system.interface.name)"
            weight: "141"
        neighbor-group:
         -
            activate: "enable"
            activate6: "enable"
            advertisement-interval: "145"
            allowas-in: "146"
            allowas-in-enable: "enable"
            allowas-in-enable6: "enable"
            allowas-in6: "149"
            as-override: "enable"
            as-override6: "enable"
            attribute-unchanged: "as-path"
            attribute-unchanged6: "as-path"
            bfd: "enable"
            capability-default-originate: "enable"
            capability-default-originate6: "enable"
            capability-dynamic: "enable"
            capability-graceful-restart: "enable"
            capability-graceful-restart6: "enable"
            capability-orf: "none"
            capability-orf6: "none"
            capability-route-refresh: "enable"
            connect-timer: "163"
            default-originate-routemap: "<your_own_value> (source router.route-map.name)"
            default-originate-routemap6: "<your_own_value> (source router.route-map.name)"
            description: "<your_own_value>"
            distribute-list-in: "<your_own_value> (source router.access-list.name)"
            distribute-list-in6: "<your_own_value> (source router.access-list6.name)"
            distribute-list-out: "<your_own_value> (source router.access-list.name)"
            distribute-list-out6: "<your_own_value> (source router.access-list6.name)"
            dont-capability-negotiate: "enable"
            ebgp-enforce-multihop: "enable"
            ebgp-multihop-ttl: "173"
            filter-list-in: "<your_own_value> (source router.aspath-list.name)"
            filter-list-in6: "<your_own_value> (source router.aspath-list.name)"
            filter-list-out: "<your_own_value> (source router.aspath-list.name)"
            filter-list-out6: "<your_own_value> (source router.aspath-list.name)"
            holdtime-timer: "178"
            interface: "<your_own_value> (source system.interface.name)"
            keep-alive-timer: "180"
            link-down-failover: "enable"
            local-as: "182"
            local-as-no-prepend: "enable"
            local-as-replace-as: "enable"
            maximum-prefix: "185"
            maximum-prefix-threshold: "186"
            maximum-prefix-threshold6: "187"
            maximum-prefix-warning-only: "enable"
            maximum-prefix-warning-only6: "enable"
            maximum-prefix6: "190"
            name: "default_name_191"
            next-hop-self: "enable"
            next-hop-self6: "enable"
            override-capability: "enable"
            passive: "enable"
            prefix-list-in: "<your_own_value> (source router.prefix-list.name)"
            prefix-list-in6: "<your_own_value> (source router.prefix-list6.name)"
            prefix-list-out: "<your_own_value> (source router.prefix-list.name)"
            prefix-list-out6: "<your_own_value> (source router.prefix-list6.name)"
            remote-as: "200"
            remove-private-as: "enable"
            remove-private-as6: "enable"
            restart-time: "203"
            retain-stale-time: "204"
            route-map-in: "<your_own_value> (source router.route-map.name)"
            route-map-in6: "<your_own_value> (source router.route-map.name)"
            route-map-out: "<your_own_value> (source router.route-map.name)"
            route-map-out6: "<your_own_value> (source router.route-map.name)"
            route-reflector-client: "enable"
            route-reflector-client6: "enable"
            route-server-client: "enable"
            route-server-client6: "enable"
            send-community: "standard"
            send-community6: "standard"
            shutdown: "enable"
            soft-reconfiguration: "enable"
            soft-reconfiguration6: "enable"
            stale-route: "enable"
            strict-capability-match: "enable"
            unsuppress-map: "<your_own_value> (source router.route-map.name)"
            unsuppress-map6: "<your_own_value> (source router.route-map.name)"
            update-source: "<your_own_value> (source system.interface.name)"
            weight: "223"
        neighbor-range:
         -
            id:  "225"
            max-neighbor-num: "226"
            neighbor-group: "<your_own_value> (source router.bgp.neighbor-group.name)"
            prefix: "<your_own_value>"
        network:
         -
            backdoor: "enable"
            id:  "231"
            prefix: "<your_own_value>"
            route-map: "<your_own_value> (source router.route-map.name)"
        network-import-check: "enable"
        network6:
         -
            backdoor: "enable"
            id:  "237"
            prefix6: "<your_own_value>"
            route-map: "<your_own_value> (source router.route-map.name)"
        redistribute:
         -
            name: "default_name_241"
            route-map: "<your_own_value> (source router.route-map.name)"
            status: "enable"
        redistribute6:
         -
            name: "default_name_245"
            route-map: "<your_own_value> (source router.route-map.name)"
            status: "enable"
        router-id: "<your_own_value>"
        scan-time: "249"
        synchronization: "enable"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)