83 lines
2.9 KiB
Markdown
83 lines
2.9 KiB
Markdown
<!--
|
|
~ 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.
|
|
-->
|
|
|
|
# Create an Inventory from Ansible inventory
|
|
|
|
In large setups, it might be beneficial to construct your inventory based on your Ansible inventory. The `from-ansible` entrypoint of the `get` command enables the user to create an ANTA inventory from Ansible.
|
|
|
|
### Command overview
|
|
|
|
```bash
|
|
$ anta get from-ansible --help
|
|
Usage: anta get from-ansible [OPTIONS]
|
|
|
|
Build ANTA inventory from an ansible inventory YAML file.
|
|
|
|
NOTE: This command does not support inline vaulted variables. Make sure to
|
|
comment them out.
|
|
|
|
Options:
|
|
-o, --output FILE Path to save inventory file [env var:
|
|
ANTA_INVENTORY; required]
|
|
--overwrite Do not prompt when overriding current inventory
|
|
[env var: ANTA_GET_FROM_ANSIBLE_OVERWRITE]
|
|
-g, --ansible-group TEXT Ansible group to filter
|
|
--ansible-inventory FILE Path to your ansible inventory file to read
|
|
[required]
|
|
--help Show this message and exit.
|
|
```
|
|
|
|
!!! warning
|
|
|
|
`anta get from-ansible` does not support inline vaulted variables, comment them out to generate your inventory.
|
|
If the vaulted variable is necessary to build the inventory (e.g. `ansible_host`), it needs to be unvaulted for `from-ansible` command to work."
|
|
|
|
|
|
The output is an inventory where the name of the container is added as a tag for each host:
|
|
|
|
```yaml
|
|
anta_inventory:
|
|
hosts:
|
|
- host: 10.73.252.41
|
|
name: srv-pod01
|
|
- host: 10.73.252.42
|
|
name: srv-pod02
|
|
- host: 10.73.252.43
|
|
name: srv-pod03
|
|
```
|
|
|
|
!!! warning
|
|
The current implementation only considers devices directly attached to a specific Ansible group and does not support inheritance when using the `--ansible-group` option.
|
|
|
|
By default, if user does not provide `--output` file, anta will save output to configured anta inventory (`anta --inventory`). If the output file has content, anta will ask user to overwrite when running in interactive console. This mechanism can be controlled by triggers in case of CI usage: `--overwrite` to force anta to overwrite file. If not set, anta will exit
|
|
|
|
|
|
### Command output
|
|
|
|
`host` value is coming from the `ansible_host` key in your inventory while `name` is the name you defined for your host. Below is an ansible inventory example used to generate previous inventory:
|
|
|
|
```yaml
|
|
---
|
|
tooling:
|
|
children:
|
|
endpoints:
|
|
hosts:
|
|
srv-pod01:
|
|
ansible_httpapi_port: 9023
|
|
ansible_port: 9023
|
|
ansible_host: 10.73.252.41
|
|
type: endpoint
|
|
srv-pod02:
|
|
ansible_httpapi_port: 9024
|
|
ansible_port: 9024
|
|
ansible_host: 10.73.252.42
|
|
type: endpoint
|
|
srv-pod03:
|
|
ansible_httpapi_port: 9025
|
|
ansible_port: 9025
|
|
ansible_host: 10.73.252.43
|
|
type: endpoint
|
|
```
|