Skip to content

Commit

Permalink
Doc(eos_cli_config_gen, eos_designs): Consistent descriptions for BGP…
Browse files Browse the repository at this point in the history
… AS schema fields re asdot notation (#3618)
  • Loading branch information
ClausHolbechArista authored Feb 16, 2024
1 parent 73108c0 commit 03555df
Show file tree
Hide file tree
Showing 14 changed files with 277 additions and 138 deletions.

Large diffs are not rendered by default.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ keys:
keys:
as:
type: str
description: BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>"
description: |-
BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>".
For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
convert_types:
- int
router_id:
Expand Down Expand Up @@ -166,7 +168,9 @@ keys:
type: str
convert_types:
- int
description: BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>"
description: |-
BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>".
For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
peer_groups:
type: list
primary_key: name
Expand All @@ -183,12 +187,16 @@ keys:
description: Key only used for documentation or validation purposes
remote_as:
type: str
description: BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>"
description: |-
BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>".
For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
convert_types:
- int
local_as:
type: str
description: BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>"
description: |-
BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>".
For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
convert_types:
- int
description:
Expand Down Expand Up @@ -387,12 +395,16 @@ keys:
type: str
remote_as:
type: str
description: BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>"
description: |-
BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>".
For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
convert_types:
- int
local_as:
type: str
description: BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>"
description: |-
BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>".
For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
convert_types:
- int
as_path:
Expand Down Expand Up @@ -572,6 +584,9 @@ keys:
type: str
convert_types:
- int
description: |-
BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>".
For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
peer:
type: str
description: Key only used for documentation or validation purposes
Expand Down Expand Up @@ -1922,7 +1937,9 @@ keys:
If both are defined, peer_filter takes precedence
remote_as:
type: str
description: BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>"
description: |-
BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>".
For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
convert_types:
- int
neighbors:
Expand All @@ -1940,7 +1957,9 @@ keys:
description: Peer-group name
remote_as:
type: str
description: BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>"
description: |-
BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>".
For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
convert_types:
- int
password:
Expand Down Expand Up @@ -1972,7 +1991,9 @@ keys:
- str
local_as:
type: str
description: BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>"
description: |-
BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>".
For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
convert_types:
- int
as_path:
Expand Down Expand Up @@ -2111,7 +2132,9 @@ keys:
description: Interface name
remote_as:
type: str
description: BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>"
description: |-
BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>".
For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
convert_types:
- int
peer_group:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Variable | Type | Required | Default | Value Restrictions | Description |
| -------- | ---- | -------- | ------- | ------------------ | ----------- |
| [<samp>bgp_as</samp>](## "bgp_as") | String | | | | AS number to use to configure overlay when "overlay_routing_protocol" == ibgp. |
| [<samp>bgp_as</samp>](## "bgp_as") | String | | | | BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>" to use to configure overlay when "overlay_routing_protocol" == ibgp.<br>For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number. |
| [<samp>bgp_default_ipv4_unicast</samp>](## "bgp_default_ipv4_unicast") | Boolean | | `False` | | Default activation of IPv4 unicast address-family on all IPv4 neighbors.<br>It is best practice to disable activation.<br> |
| [<samp>bgp_distance</samp>](## "bgp_distance") | Dictionary | | | | |
| [<samp>&nbsp;&nbsp;external_routes</samp>](## "bgp_distance.external_routes") | Integer | Required | | Min: 1<br>Max: 255 | |
Expand Down Expand Up @@ -63,7 +63,8 @@
=== "YAML"

```yaml
# AS number to use to configure overlay when "overlay_routing_protocol" == ibgp.
# BGP AS <1-4294967295> or AS number in asdot notation "<1-65535>.<0-65535>" to use to configure overlay when "overlay_routing_protocol" == ibgp.
# For asdot notation in YAML inputs, the value must be put in quotes, to prevent it from being interpreted as a float number.
bgp_as: <str>

# Default activation of IPv4 unicast address-family on all IPv4 neighbors.
Expand Down
Loading

0 comments on commit 03555df

Please sign in to comment.