| Name | pyavd-cli JSON |
| Version |
0.1.8
JSON |
| download |
| home_page | None |
| Summary | A collection of cli scripts to use pyavd |
| upload_time | 2024-08-27 15:27:36 |
| maintainer | None |
| docs_url | None |
| author | Arista Networks |
| requires_python | <4.0,>=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyAVD cli tools
A set of tools on top of [PyAVD](https://avd.arista.com/4.8/docs/pyavd.html)
to process AVD configurations with python.
## Quick start
Install with pip inside a virtual environment:
```shell
$> python -m venv .venv
$> source .venv/bin/activate
$> pip install pyavd==<pyavd version> pyavd-cli
$> pyavd-build -i inventory.yml -f FABRIC -v
```
## pyavd-build
It "builds" EOS cli configs from AVD config. Similar to the process done by an ansible
playbook that invokes the AVD roles [eos_designs](https://avd.arista.com/4.8/roles/eos_designs/index.html) and
[eos_cli_config_gen](https://avd.arista.com/4.8/roles/eos_cli_config_gen/index.html).
It uses ansible Inventory Manager to read the AVD inventory so ansible features work out of the box.
It supports inline jinja templates and custom interface description/ip addressing via python modules.
```shell
$> pyavd-build --help
usage: pyavd-build [-h] -i INVENTORY_PATH [-o CONFIG_OUTPUT_PATH] [--avd-facts-path AVD_FACTS_PATH] -f
FABRIC_GROUP_NAME [-l LIMIT] [-m MAX_WORKERS] [--strict] [--vault-id [VAULT_ID ...]] [-v]
Build AVD fabric.
options:
-h, --help show this help message and exit
-i INVENTORY_PATH, --inventory-path INVENTORY_PATH
Path to the inventory file.
-o CONFIG_OUTPUT_PATH, --config-output-path CONFIG_OUTPUT_PATH
Path to the output directory.
--avd-facts-path AVD_FACTS_PATH
If provided AVD facts will be written to this path.
-f FABRIC_GROUP_NAME, --fabric-group-name FABRIC_GROUP_NAME
Name of the fabric group.
-l LIMIT, --limit LIMIT
Limit filter for inventory.
-m MAX_WORKERS, --max-workers MAX_WORKERS
Maximum number of parallel workers.
--strict Use strict mode and fail if there is validation errors
--vault-id [VAULT_ID ...]
Vault ID used to decrypt the inventory. Multiple vault IDs can be provided.
-v, --verbose
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pyavd-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Arista Networks",
"author_email": "eosplus-dev@arista.com",
"download_url": "https://files.pythonhosted.org/packages/ac/a5/a78c431d222753ee28425523518543d726d79068bfbaa0a2f8580a707c9b/pyavd_cli-0.1.8.tar.gz",
"platform": null,
"description": "# PyAVD cli tools\n\nA set of tools on top of [PyAVD](https://avd.arista.com/4.8/docs/pyavd.html)\nto process AVD configurations with python.\n\n## Quick start\n\nInstall with pip inside a virtual environment:\n\n```shell\n$> python -m venv .venv\n$> source .venv/bin/activate\n$> pip install pyavd==<pyavd version> pyavd-cli\n$> pyavd-build -i inventory.yml -f FABRIC -v\n```\n\n## pyavd-build\n\nIt \"builds\" EOS cli configs from AVD config. Similar to the process done by an ansible\nplaybook that invokes the AVD roles [eos_designs](https://avd.arista.com/4.8/roles/eos_designs/index.html) and\n[eos_cli_config_gen](https://avd.arista.com/4.8/roles/eos_cli_config_gen/index.html).\n\nIt uses ansible Inventory Manager to read the AVD inventory so ansible features work out of the box.\nIt supports inline jinja templates and custom interface description/ip addressing via python modules.\n\n```shell\n$> pyavd-build --help\nusage: pyavd-build [-h] -i INVENTORY_PATH [-o CONFIG_OUTPUT_PATH] [--avd-facts-path AVD_FACTS_PATH] -f\n FABRIC_GROUP_NAME [-l LIMIT] [-m MAX_WORKERS] [--strict] [--vault-id [VAULT_ID ...]] [-v]\n\nBuild AVD fabric.\n\noptions:\n -h, --help show this help message and exit\n -i INVENTORY_PATH, --inventory-path INVENTORY_PATH\n Path to the inventory file.\n -o CONFIG_OUTPUT_PATH, --config-output-path CONFIG_OUTPUT_PATH\n Path to the output directory.\n --avd-facts-path AVD_FACTS_PATH\n If provided AVD facts will be written to this path.\n -f FABRIC_GROUP_NAME, --fabric-group-name FABRIC_GROUP_NAME\n Name of the fabric group.\n -l LIMIT, --limit LIMIT\n Limit filter for inventory.\n -m MAX_WORKERS, --max-workers MAX_WORKERS\n Maximum number of parallel workers.\n --strict Use strict mode and fail if there is validation errors\n --vault-id [VAULT_ID ...]\n Vault ID used to decrypt the inventory. Multiple vault IDs can be provided.\n -v, --verbose\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A collection of cli scripts to use pyavd",
"version": "0.1.8",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c608517c36269e53aac0152432cc966c2be5b57d9e648cc0069bbf4af4cc1c60",
"md5": "d37f17789745d011b6809ea788cb6fed",
"sha256": "f976dc3819bd32e5cdd273ec97c478190814a310b96e9405950260156b6fef08"
},
"downloads": -1,
"filename": "pyavd_cli-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d37f17789745d011b6809ea788cb6fed",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 14428,
"upload_time": "2024-08-27T15:27:35",
"upload_time_iso_8601": "2024-08-27T15:27:35.655276Z",
"url": "https://files.pythonhosted.org/packages/c6/08/517c36269e53aac0152432cc966c2be5b57d9e648cc0069bbf4af4cc1c60/pyavd_cli-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aca5a78c431d222753ee28425523518543d726d79068bfbaa0a2f8580a707c9b",
"md5": "d29c5639e0e5ba7c530dfffb1c6a80f6",
"sha256": "e60dd66e1ecb1bb2943a2032765015aecd74fea00171d305355e93d3b785f936"
},
"downloads": -1,
"filename": "pyavd_cli-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "d29c5639e0e5ba7c530dfffb1c6a80f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 9173,
"upload_time": "2024-08-27T15:27:36",
"upload_time_iso_8601": "2024-08-27T15:27:36.766983Z",
"url": "https://files.pythonhosted.org/packages/ac/a5/a78c431d222753ee28425523518543d726d79068bfbaa0a2f8580a707c9b/pyavd_cli-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-27 15:27:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyavd-cli"
}
