From 26c6d9f160bac2167c96fe86226eab16de45b45e Mon Sep 17 00:00:00 2001 From: Carl Buchmann Date: Wed, 11 Dec 2024 09:46:14 -0500 Subject: [PATCH] Doc(eos_cli_config_gen): Improve snmp server documention --- .../avd/roles/eos_cli_config_gen/docs/tables/snmp-server.md | 4 ++-- .../roles/eos_designs/docs/tables/management-snmp-settings.md | 4 ++-- python-avd/pyavd/_eos_cli_config_gen/schema/__init__.py | 4 ++-- .../_eos_cli_config_gen/schema/eos_cli_config_gen.schema.yml | 2 +- .../schema/schema_fragments/snmp_server.schema.yml | 2 +- python-avd/pyavd/_eos_designs/schema/__init__.py | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/snmp-server.md b/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/snmp-server.md index d903e11168e..f4bc7bbfe51 100644 --- a/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/snmp-server.md +++ b/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/snmp-server.md @@ -60,7 +60,7 @@ | [    - host](## "snmp_server.hosts.[].host") | String | | | | Host IP address or name. | | [      vrf](## "snmp_server.hosts.[].vrf") | String | | | | | | [      version](## "snmp_server.hosts.[].version") | String | | | Valid Values:
- 1
- 2c
- 3 | | - | [      community](## "snmp_server.hosts.[].community") | String | | | | Community name. | + | [      community](## "snmp_server.hosts.[].community") | String | | | | Community name. Required when version "1" or "2c". | | [      users](## "snmp_server.hosts.[].users") | List, items: Dictionary | | | | | | [        - username](## "snmp_server.hosts.[].users.[].username") | String | | | | | | [          authentication_level](## "snmp_server.hosts.[].users.[].authentication_level") | String | | | Valid Values:
- auth
- noauth
- priv | | @@ -184,7 +184,7 @@ vrf: version: - # Community name. + # Community name. Required when version "1" or "2c". community: users: - username: diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/tables/management-snmp-settings.md b/ansible_collections/arista/avd/roles/eos_designs/docs/tables/management-snmp-settings.md index fbbd409172a..948026928b0 100644 --- a/ansible_collections/arista/avd/roles/eos_designs/docs/tables/management-snmp-settings.md +++ b/ansible_collections/arista/avd/roles/eos_designs/docs/tables/management-snmp-settings.md @@ -32,7 +32,7 @@ | [      use_mgmt_interface_vrf](## "snmp_settings.hosts.[].use_mgmt_interface_vrf") | Boolean | | | | Configure the SNMP host under the VRF set with "mgmt_interface_vrf". Ignored if 'mgmt_ip' or 'ipv6_mgmt_ip' are not configured for the device, so if the host is only configured with this VRF, the host will not be configured at all. Can be used in combination with "vrf" and "use_inband_mgmt_vrf" to configure the SNMP host under multiple VRFs. | | [      use_inband_mgmt_vrf](## "snmp_settings.hosts.[].use_inband_mgmt_vrf") | Boolean | | | | Configure the SNMP host under the VRF set with "inband_mgmt_vrf". Ignored if inband management is not configured for the device, so if the host is only configured with this VRF, the host will not be configured at all. Can be used in combination with "vrf" and "use_mgmt_interface_vrf" to configure the SNMP host under multiple VRFs. | | [      version](## "snmp_settings.hosts.[].version") | String | | | Valid Values:
- 1
- 2c
- 3 | | - | [      community](## "snmp_settings.hosts.[].community") | String | | | | Community name. | + | [      community](## "snmp_settings.hosts.[].community") | String | | | | Community name. Required when version "1" or "2c". | | [      users](## "snmp_settings.hosts.[].users") | List, items: Dictionary | | | | | | [        - username](## "snmp_settings.hosts.[].users.[].username") | String | | | | | | [          authentication_level](## "snmp_settings.hosts.[].users.[].authentication_level") | String | | | Valid Values:
- auth
- noauth
- priv | | @@ -151,7 +151,7 @@ use_inband_mgmt_vrf: version: - # Community name. + # Community name. Required when version "1" or "2c". community: users: - username: diff --git a/python-avd/pyavd/_eos_cli_config_gen/schema/__init__.py b/python-avd/pyavd/_eos_cli_config_gen/schema/__init__.py index 05f524ba330..b6d4fdd5b13 100644 --- a/python-avd/pyavd/_eos_cli_config_gen/schema/__init__.py +++ b/python-avd/pyavd/_eos_cli_config_gen/schema/__init__.py @@ -60950,7 +60950,7 @@ class Users(AvdList[UsersItem]): vrf: str | None version: Literal["1", "2c", "3"] | None community: str | None - """Community name.""" + """Community name. Required when version "1" or "2c".""" users: Users """Subclass of AvdList with `UsersItem` items.""" _custom_data: dict[str, Any] @@ -60977,7 +60977,7 @@ def __init__( host: Host IP address or name. vrf: vrf version: version - community: Community name. + community: Community name. Required when version "1" or "2c". users: Subclass of AvdList with `UsersItem` items. _custom_data: _custom_data diff --git a/python-avd/pyavd/_eos_cli_config_gen/schema/eos_cli_config_gen.schema.yml b/python-avd/pyavd/_eos_cli_config_gen/schema/eos_cli_config_gen.schema.yml index 092b4cf020e..bf0e0dbf5e4 100644 --- a/python-avd/pyavd/_eos_cli_config_gen/schema/eos_cli_config_gen.schema.yml +++ b/python-avd/pyavd/_eos_cli_config_gen/schema/eos_cli_config_gen.schema.yml @@ -20194,7 +20194,7 @@ keys: - '3' community: type: str - description: Community name. + description: Community name. Required when version "1" or "2c". users: type: list items: diff --git a/python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/snmp_server.schema.yml b/python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/snmp_server.schema.yml index be3e01651f3..bf2e05519d3 100644 --- a/python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/snmp_server.schema.yml +++ b/python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/snmp_server.schema.yml @@ -215,7 +215,7 @@ keys: valid_values: ["1", "2c", "3"] community: type: str - description: Community name. + description: Community name. Required when version "1" or "2c". users: type: list items: diff --git a/python-avd/pyavd/_eos_designs/schema/__init__.py b/python-avd/pyavd/_eos_designs/schema/__init__.py index afa5548636b..959c6cd59dc 100644 --- a/python-avd/pyavd/_eos_designs/schema/__init__.py +++ b/python-avd/pyavd/_eos_designs/schema/__init__.py @@ -12836,7 +12836,7 @@ class Users(AvdList[UsersItem]): """ version: Literal["1", "2c", "3"] | None community: str | None - """Community name.""" + """Community name. Required when version "1" or "2c".""" users: Users """Subclass of AvdList with `UsersItem` items.""" _custom_data: dict[str, Any] @@ -12878,7 +12878,7 @@ def __init__( configured at all. Can be used in combination with "vrf" and "use_mgmt_interface_vrf" to configure the SNMP host under multiple VRFs. version: version - community: Community name. + community: Community name. Required when version "1" or "2c". users: Subclass of AvdList with `UsersItem` items. _custom_data: _custom_data