diff --git a/changelogs/fragments/doc_updated_correct_platform.yaml b/changelogs/fragments/doc_updated_correct_platform.yaml
new file mode 100644
index 0000000..d16f673
--- /dev/null
+++ b/changelogs/fragments/doc_updated_correct_platform.yaml
@@ -0,0 +1,3 @@
+---
+trivial:
+ - Documentation update with correct platform name.
diff --git a/docs/vyos.vyos.vyos_bgp_address_family_module.rst b/docs/vyos.vyos.vyos_bgp_address_family_module.rst
index 0c463d0..a213ff0 100644
--- a/docs/vyos.vyos.vyos_bgp_address_family_module.rst
+++ b/docs/vyos.vyos.vyos_bgp_address_family_module.rst
@@ -1,2085 +1,2085 @@
.. _vyos.vyos.vyos_bgp_address_family_module:
*********************************
vyos.vyos.vyos_bgp_address_family
*********************************
**BGP Address Family Resource Module.**
Version added: 2.1.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module manages BGP address family configuration of interfaces on devices running VYOS.
Parameters
----------
.. raw:: html
Parameter |
Choices/Defaults |
Comments |
config
dictionary
|
|
A dict of BGP global configuration for interfaces.
|
|
address_family
list
/ elements=dictionary
|
|
BGP address-family parameters.
|
|
|
afi
string
|
|
BGP address family settings.
|
|
|
aggregate_address
list
/ elements=dictionary
|
|
BGP aggregate network.
|
|
|
|
as_set
boolean
|
|
Generate AS-set path information for this aggregate address.
|
|
|
|
prefix
string
|
|
BGP aggregate network.
|
|
|
|
summary_only
boolean
|
|
Announce the aggregate summary network only.
|
|
|
networks
list
/ elements=dictionary
|
|
BGP network
|
|
|
|
backdoor
boolean
|
|
Network as a backdoor route.
|
|
|
|
path_limit
integer
|
|
AS path hop count limit
|
|
|
|
prefix
string
|
|
BGP network address
|
|
|
|
route_map
string
|
|
Route-map to modify route attributes
|
|
|
redistribute
list
/ elements=dictionary
|
|
Redistribute routes from other protocols into BGP
|
|
|
|
metric
integer
|
|
Metric for redistributed routes.
|
|
|
|
protocol
string
|
Choices:
- connected
- kernel
- ospf
- ospfv3
- rip
- ripng
- static
|
types of routes to be redistributed.
|
|
|
|
route_map
string
|
|
Route map to filter redistributed routes
|
|
|
|
table
string
|
|
Redistribute non-main Kernel Routing Table.
|
|
as_number
integer
|
|
AS number.
|
|
neighbors
list
/ elements=dictionary
|
|
BGP neighbor
|
|
|
address_family
list
/ elements=dictionary
|
|
address family.
|
|
|
|
afi
string
|
|
BGP neighbor parameters.
|
|
|
|
allowas_in
integer
|
|
Number of occurrences of AS number.
|
|
|
|
as_override
boolean
|
|
AS for routes sent to this neighbor to be the local AS.
|
|
|
|
attribute_unchanged
dictionary
|
|
BGP attributes are sent unchanged.
|
|
|
|
|
as_path
boolean
|
|
as_path attribute
|
|
|
|
|
med
boolean
|
|
med attribute
|
|
|
|
|
next_hop
boolean
|
|
next_hop attribute
|
|
|
|
capability
dictionary
|
|
Advertise capabilities to this neighbor.
|
|
|
|
|
dynamic
boolean
|
|
Advertise dynamic capability to this neighbor.
|
|
|
|
|
orf
string
|
|
Advertise ORF capability to this neighbor.
|
|
|
|
default_originate
string
|
|
Send default route to this neighbor
|
|
|
|
distribute_list
list
/ elements=dictionary
|
|
Access-list to filter route updates to/from this neighbor.
|
|
|
|
|
acl
integer
|
|
Access-list number.
|
|
|
|
|
action
string
|
|
Access-list to filter outgoing/incoming route updates to this neighbor
|
|
|
|
filter_list
list
/ elements=dictionary
|
|
As-path-list to filter route updates to/from this neighbor.
|
|
|
|
|
action
string
|
|
filter outgoing/incoming route updates
|
|
|
|
|
path_list
string
|
|
As-path-list to filter
|
|
|
|
maximum_prefix
integer
|
|
Maximum number of prefixes to accept from this neighbor nexthop-self Nexthop for routes sent to this neighbor to be the local router.
|
|
|
|
nexthop_local
boolean
|
|
Nexthop attributes.
|
|
|
|
nexthop_self
boolean
|
|
Nexthop for routes sent to this neighbor to be the local router.
|
|
|
|
peer_group
string
|
|
IPv4 peer group for this peer
|
|
|
|
prefix_list
list
/ elements=dictionary
|
|
Prefix-list to filter route updates to/from this neighbor.
|
|
|
|
|
action
string
|
|
filter outgoing/incoming route updates
|
|
|
|
|
prefix_list
string
|
|
Prefix-list to filter
|
|
|
|
remove_private_as
boolean
|
|
Remove private AS numbers from AS path in outbound route updates
|
|
|
|
route_map
list
/ elements=dictionary
|
|
Route-map to filter route updates to/from this neighbor.
|
|
|
|
|
action
string
|
|
filter outgoing/incoming route updates
|
|
|
|
|
route_map
string
|
|
route-map to filter
|
|
|
|
route_reflector_client
boolean
|
|
Neighbor as a route reflector client
|
|
|
|
route_server_client
boolean
|
|
Neighbor is route server client
|
|
|
|
soft_reconfiguration
boolean
|
|
Soft reconfiguration for neighbor
|
|
|
|
unsupress_map
string
|
|
Route-map to selectively unsuppress suppressed routes
|
|
|
|
weight
integer
|
|
Default weight for routes from this neighbor
|
|
|
neighbor_address
string
|
|
BGP neighbor address (v4/v6).
|
running_config
string
|
|
This option is used only with state parsed.
- The value of this option should be the output received from the IOS device by executing the command show configuration command | match bgp.
+ The value of this option should be the output received from the VYOS device by executing the command show configuration command | match bgp.
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
|
state
string
|
Choices:
merged ←
- replaced
- deleted
- gathered
- parsed
- rendered
- purged
- overridden
|
The state the configuration should be left in.
|
Parameter |
Choices/Defaults |
Comments |
config
list
/ elements=dictionary
|
|
A list of OSPF configuration for interfaces.
|
|
address_family
list
/ elements=dictionary
|
|
OSPF settings on the interfaces in address-family context.
|
|
|
afi
string
/ required
|
|
Address Family Identifier (AFI) for OSPF settings on the interfaces.
|
|
|
authentication
dictionary
|
|
Authentication settings on the interface.
|
|
|
|
md5_key
dictionary
|
|
md5 parameters.
|
|
|
|
|
key
string
|
|
md5 key.
|
|
|
|
|
key_id
integer
|
|
key id.
|
|
|
|
plaintext_password
string
|
|
Plain Text password.
|
|
|
bandwidth
integer
|
|
Bandwidth of interface (kilobits/sec)
|
|
|
cost
integer
|
|
metric associated with interface.
|
|
|
dead_interval
integer
|
|
Time interval to detect a dead router.
|
|
|
hello_interval
integer
|
|
Timer interval between transmission of hello packets.
|
|
|
ifmtu
integer
|
|
interface MTU.
|
|
|
instance
string
|
|
Instance ID.
|
|
|
mtu_ignore
boolean
|
|
if True, Disable MTU check for Database Description packets.
|
|
|
network
string
|
|
Interface type.
|
|
|
passive
boolean
|
|
If True, disables forming adjacency.
|
|
|
priority
integer
|
|
Interface priority.
|
|
|
retransmit_interval
integer
|
|
LSA retransmission interval.
|
|
|
transmit_delay
integer
|
|
LSA transmission delay.
|
|
name
string
|
|
Name/Identifier of the interface.
|
running_config
string
|
|
This option is used only with state parsed.
- The value of this option should be the output received from the IOS device by executing the command sh running-config | section ^interface.
+ The value of this option should be the output received from the VYOS device by executing the command show configuration commands | match "set interfaces".
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
|
state
string
|
Choices:
merged ←
- replaced
- overridden
- deleted
- gathered
- parsed
- rendered
|
The state the configuration should be left in.
|