diff options
Diffstat (limited to 'docs/api/models.md')
-rw-r--r-- | docs/api/models.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/api/models.md b/docs/api/models.md new file mode 100644 index 0000000..b0c1e91 --- /dev/null +++ b/docs/api/models.md @@ -0,0 +1,37 @@ +<!-- + ~ Copyright (c) 2023-2024 Arista Networks, Inc. + ~ Use of this source code is governed by the Apache License 2.0 + ~ that can be found in the LICENSE file. + --> + +# Test definition + +## UML Diagram + +![](../imgs/uml/anta.models.AntaTest.jpeg) + +### ::: anta.models.AntaTest + options: + filters: ["!^_[^_]", "!__init_subclass__", "!update_progress"] + +# Command definition + +## UML Diagram + +![](../imgs/uml/anta.models.AntaCommand.jpeg) +### ::: anta.models.AntaCommand + +!!! warning + CLI commands are protected to avoid execution of critical commands such as `reload` or `write erase`. + + - Reload command: `^reload\s*\w*` + - Configure mode: `^conf\w*\s*(terminal|session)*` + - Write: `^wr\w*\s*\w+` + +# Template definition + +## UML Diagram + +![](../imgs/uml/anta.models.AntaTemplate.jpeg) + +### ::: anta.models.AntaTemplate |