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

Feat(eos_cli_config_gen): Added login/motd banner in device documentation #4855

Merged
merged 8 commits into from
Jan 13, 2025
Merged

Feat(eos_cli_config_gen): Added login/motd banner in device documentation #4855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0993d6c
added login/motd banners in device documentation
Jan 6, 2025
a2a65f0
moved banner into management and added quote before the banner
Jan 10, 2025
aac7cc8
Apply suggestions from code review
gmuloc Jan 10, 2025
78365a4
Merge branch 'devel' into issue-4644
gmuloc Jan 10, 2025
783a0e2
Merge branch 'devel' into issue-4644
ClausHolbechArista Jan 13, 2025
fbd2c0c
Merge branch 'devel' into issue-4644
gmuloc Jan 13, 2025
f91ea55
Merge branch 'devel' into issue-4644
gmuloc Jan 13, 2025
b4465e5
Merge branch 'devel' into issue-4644
gmuloc Jan 13, 2025
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
20 changes: 20 additions & 0 deletions ...llections/arista/avd/molecule/eos_cli_config_gen/documentation/devices/host1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Table of Contents

- [Management](#management)
- [Banner](#banner)
- [Agents](#agents)
- [Management Interfaces](#management-interfaces)
- [DNS Domain](#dns-domain)
Expand Down Expand Up @@ -271,6 +272,25 @@

## Management

### Banner

#### Login Banner

```text
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!***!!!Unauthorized access prohibited!!!***!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
```

#### MOTD Banner

```text
. Switch : $(hostname) .
. Site : DC1 .
. Type info for information about the device .
. Type help for information about the aliases .
```

### Agents

#### Agent Dummy
Expand Down
22 changes: 22 additions & 0 deletions ...llections/arista/avd/molecule/eos_cli_config_gen/documentation/devices/host2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Table of Contents

- [Management](#management)
- [Banner](#banner)
- [Management Interfaces](#management-interfaces)
- [Management SSH](#management-ssh)
- [Management API gNMI](#management-api-gnmi)
Expand Down Expand Up @@ -87,6 +88,27 @@

## Management

### Banner

#### Login Banner

```text
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!***!!!Unauthorized access prohibited!!!***!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
EOF
```

#### MOTD Banner

```text
. Switch : $(hostname) .
. Site : DC1 .
. Type info for information about the device .
. Type help for information about the aliases .
EOF
```

### Management Interfaces

#### Management Interfaces Summary
Expand Down
26 changes: 26 additions & 0 deletions python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation/banners.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{#
Copyright (c) 2025 Arista Networks, Inc.
Use of this source code is governed by the Apache License 2.0
that can be found in the LICENSE file.
#}
{# doc - banners #}
{% if banners.login is arista.avd.defined or banners.motd is arista.avd.defined %}

### Banner
{% if banners.login is arista.avd.defined %}

#### Login Banner

```text
{{ banners.login.rstrip() }}
```
{% endif %}
{% if banners.motd is arista.avd.defined %}

#### MOTD Banner

```text
{{ banners.motd.rstrip() }}
```
{% endif %}
{% endif %}
6 changes: 5 additions & 1 deletion python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation/management.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,13 @@
or ip_ftp_client_source_interfaces is arista.avd.defined
or ip_tftp_client_source_interfaces is arista.avd.defined
or ip_telnet_client_source_interfaces is arista.avd.defined
or agent is arista.avd.defined %}
or agent is arista.avd.defined
or banners.login is arista.avd.defined
or banners.motd is arista.avd.defined %}

## Management
{## Banner #}
{% include 'documentation/banners.j2' %}
{## Agents #}
{% include 'documentation/agents.j2' %}
{## Management Interface #}
Expand Down
Loading