Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc: Fix incorrect keys specified in default_mgmt_method #4206

Merged
merged 4 commits into from
Jul 23, 2024
Merged

Doc: Fix incorrect keys specified in default_mgmt_method #4206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a7a06af
Doc: Fix incorrect keys specified in default_mgmt_method
carlbuchmann Jul 11, 2024
597eb7b
Update python-avd/pyavd/_eos_designs/schema/schema_fragments/default_…
gmuloc Jul 22, 2024
1d751bd
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 22, 2024
9bca633
Merge branch 'devel' into fix-management-settings-doc
ClausHolbechArista Jul 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions ...tions/arista/avd/roles/eos_designs/docs/tables/management-interface-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Variable | Type | Required | Default | Value Restrictions | Description |
| -------- | ---- | -------- | ------- | ------------------ | ----------- |
| [<samp>default_mgmt_method</samp>](## "default_mgmt_method") | String | | `oob` | Valid Values:<br>- <code>oob</code><br>- <code>inband</code><br>- <code>none</code> | `default_mgmt_method` controls the default VRF and source interface used for the following management and monitoring protocols configured with `eos_designs`:<br> - `cv_settings`<br> - `dns_settings`<br> - `ntp_settings`<br> - `sflow_settings`<br><br>`oob` means the protocols will be configured with the VRF set by `mgmt_interface_vrf` and `mgmt_interface` as the source interface.<br>`inband` means the protocols will be configured with the VRF set by `inband_mgmt_vrf` and `inband_mgmt_interface` as the source interface.<br>`none` means the VRF and or interface must be manually set for each protocol.<br>This can be overridden under the settings for each protocol.<br> |
| [<samp>default_mgmt_method</samp>](## "default_mgmt_method") | String | | `oob` | Valid Values:<br>- <code>oob</code><br>- <code>inband</code><br>- <code>none</code> | `default_mgmt_method` controls the default VRF and source interface used for the following management and monitoring protocols configured with `eos_designs`:<br> - `ntp_settings`<br> - `sflow_settings`<br><br>`oob` means the protocols will be configured with the VRF set by `mgmt_interface_vrf` and `mgmt_interface` as the source interface.<br>`inband` means the protocols will be configured with the VRF set by `inband_mgmt_vrf` and `inband_mgmt_interface` as the source interface.<br>`none` means the VRF and or interface must be manually set for each protocol.<br>This can be overridden under the settings for each protocol.<br> |
| [<samp>mgmt_destination_networks</samp>](## "mgmt_destination_networks") | List, items: String | | | | List of IPv4 prefixes to configure as static routes towards the OOB Management interface gateway.<br>Replaces the default route. |
| [<samp>&nbsp;&nbsp;-&nbsp;&lt;str&gt;</samp>](## "mgmt_destination_networks.[]") | String | | | | IPv4_address/Mask. |
| [<samp>mgmt_gateway</samp>](## "mgmt_gateway") | String | | | | OOB Management interface gateway in IPv4 format.<br>Used as next-hop for default gateway or static routes defined under 'mgmt_destination_networks'.<br> |
Expand All @@ -20,8 +20,6 @@

```yaml
# `default_mgmt_method` controls the default VRF and source interface used for the following management and monitoring protocols configured with `eos_designs`:
# - `cv_settings`
# - `dns_settings`
# - `ntp_settings`
# - `sflow_settings`
#
Expand Down
2 changes: 1 addition & 1 deletion python-avd/pyavd/_eos_designs/schema/eos_designs.jsonschema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5973,7 +5973,7 @@
},
"default_mgmt_method": {
"type": "string",
"description": "`default_mgmt_method` controls the default VRF and source interface used for the following management and monitoring protocols configured with `eos_designs`:\n - `cv_settings`\n - `dns_settings`\n - `ntp_settings`\n - `sflow_settings`\n\n`oob` means the protocols will be configured with the VRF set by `mgmt_interface_vrf` and `mgmt_interface` as the source interface.\n`inband` means the protocols will be configured with the VRF set by `inband_mgmt_vrf` and `inband_mgmt_interface` as the source interface.\n`none` means the VRF and or interface must be manually set for each protocol.\nThis can be overridden under the settings for each protocol.\n",
"description": "`default_mgmt_method` controls the default VRF and source interface used for the following management and monitoring protocols configured with `eos_designs`:\n - `ntp_settings`\n - `sflow_settings`\n\n`oob` means the protocols will be configured with the VRF set by `mgmt_interface_vrf` and `mgmt_interface` as the source interface.\n`inband` means the protocols will be configured with the VRF set by `inband_mgmt_vrf` and `inband_mgmt_interface` as the source interface.\n`none` means the VRF and or interface must be manually set for each protocol.\nThis can be overridden under the settings for each protocol.\n",
"enum": [
"oob",
"inband",
Expand Down
12 changes: 6 additions & 6 deletions python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -972,12 +972,12 @@ keys:
type: str
description: "`default_mgmt_method` controls the default VRF and source interface
used for the following management and monitoring protocols configured with `eos_designs`:\n
\ - `cv_settings`\n - `dns_settings`\n - `ntp_settings`\n - `sflow_settings`\n\n`oob`
means the protocols will be configured with the VRF set by `mgmt_interface_vrf`
and `mgmt_interface` as the source interface.\n`inband` means the protocols
will be configured with the VRF set by `inband_mgmt_vrf` and `inband_mgmt_interface`
as the source interface.\n`none` means the VRF and or interface must be manually
set for each protocol.\nThis can be overridden under the settings for each protocol.\n"
\ - `ntp_settings`\n - `sflow_settings`\n\n`oob` means the protocols will be
configured with the VRF set by `mgmt_interface_vrf` and `mgmt_interface` as
the source interface.\n`inband` means the protocols will be configured with
the VRF set by `inband_mgmt_vrf` and `inband_mgmt_interface` as the source interface.\n`none`
means the VRF and or interface must be manually set for each protocol.\nThis
can be overridden under the settings for each protocol.\n"
valid_values:
- oob
- inband
Expand Down
2 changes: 0 additions & 2 deletions python-avd/pyavd/_eos_designs/schema/schema_fragments/default_mgmt_method.schema.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ keys:
type: str
description: |
`default_mgmt_method` controls the default VRF and source interface used for the following management and monitoring protocols configured with `eos_designs`:
- `cv_settings`
- `dns_settings`
- `ntp_settings`
- `sflow_settings`
Expand Down
Loading