graphiant.naas.graphiant_bgp module – Manage Graphiant BGP peering, routing policies, and route aggregations
Note
This module is part of the graphiant.naas collection (version 26.7.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install graphiant.naas.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: graphiant.naas.graphiant_bgp.
New in graphiant.naas 25.12.0
Synopsis
This module provides comprehensive BGP peering and routing policy management for Graphiant Edge devices.
Supports BGP peering neighbor configuration and deconfiguration.
Enables attachment and detachment of global BGP routing policies (filters) to BGP peers.
Supports BGP route aggregation configuration per LAN segment.
Neighbors and aggregations are independent — a segment can define either or both.
All operations use Jinja2 templates for consistent configuration deployment.
Configuration files support Jinja2 templating for dynamic generation.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.7
graphiant-sdk >= 26.7.0
Parameters
Parameter |
Comments |
|---|---|
Bearer token for API authentication (for example, from If not passed as a module argument, the collection reads When a bearer token is present (module argument or environment), it takes precedence over If no valid token is available, the module authenticates with |
|
Path to the BGP configuration YAML file. Required for all operations. Can be an absolute path or relative path. Relative paths are resolved using the configured config_path. Configuration files support Jinja2 templating syntax for dynamic generation. File must contain either BGP peering neighbor definitions or route aggregation definitions, or both. |
|
Enable detailed logging output for troubleshooting and monitoring. When enabled, provides comprehensive logs of all BGP operations. Logs are captured and included in the result_msg for display using ansible.builtin.debug module. Choices:
|
|
Graphiant portal host URL for API connectivity. Example: “https://api.graphiant.com” |
|
The specific BGP operation to perform.
Choices:
|
|
Graphiant portal password for authentication. Required for password-based login when no valid bearer token is available from |
|
Graphiant portal username for authentication. Required for password-based login when no valid bearer token is available from |
Attributes
Attribute |
Support |
Description |
|---|---|---|
Support: partial The module cannot accurately determine whether changes would actually be made without querying the current state via API calls. In check mode, the module assumes that changes would be made and returns |
Supports check mode with partial support. |
Notes
Note
BGP Operations:
- Configure (state: present): Create BGP peering neighbors, route aggregations, and attach routing policies.
- Deconfigure (state: absent): Remove BGP peering neighbors and route aggregations. Policies are detached.
- Detach Policies: Detach global BGP routing policies from BGP peers without removing the peers or aggregations.
Configuration files support Jinja2 templating syntax for dynamic configuration generation.
The module automatically resolves device names, site names, and policy names to IDs.
All operations are idempotent and safe to run multiple times.
Global BGP filters must be created using graphiant.naas.graphiant_global_config module
before attaching to BGP peers.
BGP Aggregation config file fields per segment entry:
bgp_aggregations: list of aggregation entries, each with:
prefix (required): The network prefix to aggregate, e.g. 1.1.1.0/27.
as_set (optional, default false): Include AS set information in the aggregated route.
summary_only (optional, default false): Suppress advertisement of more-specific routes.
See Also
See also
- graphiant.naas.graphiant_interfaces
Configure interfaces before setting up BGP peering
- graphiant.naas.graphiant_global_config
Configure global BGP filters (routing policies) that can be attached to BGP peers
Examples
- name: Configure BGP peering, route aggregations and attach policies
graphiant.naas.graphiant_bgp:
operation: configure
bgp_config_file: "sample_bgp_peering.yaml"
host: "{{ graphiant_host }}"
username: "{{ graphiant_username }}"
password: "{{ graphiant_password }}"
detailed_logs: true
register: bgp_result
- name: Detach policies from BGP peers
graphiant.naas.graphiant_bgp:
operation: detach_policies
bgp_config_file: "sample_bgp_peering.yaml"
host: "{{ graphiant_host }}"
username: "{{ graphiant_username }}"
password: "{{ graphiant_password }}"
detailed_logs: true
- name: Deconfigure BGP peering and aggregations
graphiant.naas.graphiant_bgp:
operation: deconfigure
bgp_config_file: "sample_bgp_peering.yaml"
host: "{{ graphiant_host }}"
username: "{{ graphiant_username }}"
password: "{{ graphiant_password }}"
- name: Configure BGP peering using state parameter
graphiant.naas.graphiant_bgp:
state: present
bgp_config_file: "sample_bgp_peering.yaml"
host: "{{ graphiant_host }}"
username: "{{ graphiant_username }}"
password: "{{ graphiant_password }}"
- name: Deconfigure BGP peering and aggregations using state parameter
graphiant.naas.graphiant_bgp:
state: absent
bgp_config_file: "sample_bgp_peering.yaml"
host: "{{ graphiant_host }}"
username: "{{ graphiant_username }}"
password: "{{ graphiant_password }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The BGP configuration file used for the operation. Returned: always Sample: |
|
Whether the operation made changes to the system.
Returned: always Sample: |
|
Result message from the operation, including detailed logs when Returned: always Sample: |
|
The operation that was performed. One of Returned: always Sample: |