volant inventory
Imprime un inventario como JSON, YAML o TOML, igual que ansible-inventory.
volant inventory imprime un inventario como JSON, YAML o TOML, igual que ansible-inventory. Iniciado con el nombre ansible-inventory (consulta el comando shims), se comporta igual.
volant inventory (--list | --host HOST | --graph [GROUP]) [-i SOURCE]... [-l SUBSET] [-e VARS]... [--vars] [-y | --toml] [--export] [--output FILE] [-v]Se requiere exactamente una de --list, --host y --graph.
Imprime cada host con sus variables, con los archivos group_vars y host_vars y las variables de sus grupos ya incorporados, y luego los grupos con sus hosts y children. Las claves van ordenadas, la sangría es de cuatro espacios y el texto no ASCII se escribe tal cual. Una cadena que es un dato se imprime como {"__ansible_unsafe": "..."} y un valor !vault como {"__ansible_vault": "..."}; no se descifra nada.
Imprime las variables de un host. HOST es un patrón de hosts que debe coincidir con exactamente un host; si no, el comando imprime You must pass a single valid host to --host parameter y sale con el código 5. --limit no se aplica.
Imprime los grupos como un árbol: @name: para un grupo, nombres sueltos para los hosts, los hijos de un grupo antes que sus hosts, cada nivel con sangría de |. Con el nombre de un grupo, imprime solo ese subárbol. Un nombre que no es un grupo imprime Pattern must be valid group name when using --graph y sale con el código 5. --limit no se aplica.
Con --graph, añade líneas {name = value} bajo cada host (sus variables ya combinadas) y cada grupo (las suyas, incluidos los archivos group_vars), ordenadas por nombre y escritas con el str() de Python. Los valores !vault se descifran, así que esto necesita la contraseña de vault, y el texto !unsafe se imprime tal cual. Las demás acciones ignoran --vars.
Imprime --list y --host como YAML, byte a byte como ansible-inventory. --list se convierte en un inventario que se puede volver a leer: cada grupo bajo los children de su padre, con sus hosts y sus variables, claves ordenadas. Un host se escribe con sus variables la primera vez que el recorrido lo alcanza y como {} después, un grupo ya escrito es {}, y un grupo vacío se omite. Un valor !vault se escribe como !vault | y su texto cifrado, sin descifrarlo. El texto !unsafe se escribe como texto plano. --graph ignora --yaml.
Cuando varios hosts reciben una variable del mismo grupo, del mismo archivo group_vars o de -e, la referencia guarda un solo valor para todos, y PyYAML lo escribe una vez con un ancla (&id001) y luego como alias (*id001). Volant escribe las mismas anclas con los mismos números. PyYAML numera un valor cuando lo encuentra por segunda vez, así que id001 no siempre es la primera ancla del archivo. Solo las listas y los mapeos reciben anclas.
all: children: prod: children: web: hosts: w1: list: &id001 - 1 - 2 w2: list: *id001Imprime --list y --host como TOML, con la disposición que imprime ansible-inventory con el paquete tomli-w; Volant no necesita ningún paquete para ello. --list tiene una tabla por grupo que tenga algo que mostrar: [group] con children como nombres, y [group.hosts.host] con las variables del host. No hay tabla all, y un grupo que solo tiene hosts no tiene línea [group]. Las variables no se ordenan: vienen en el orden en que la referencia las combina, primero las de los grupos y por último las del propio host. Las variables de un host se escriben donde el recorrido lo alcanza por primera vez, así que un host que está en varios grupos tiene una tabla vacía en los demás. Los arrays se escriben con un elemento por línea, una coma final y cuatro espacios de sangría. --host imprime las variables como un documento plano. --yaml gana cuando se dan ambas, y --graph ignora --toml.
Un documento sin nada imprime nada y sale con 1, como hace la referencia. Un null no se puede escribir en TOML: el comando imprime [ERROR]: Object of type 'NoneType' is not TOML serializable y sale con 250. La referencia también sale con 250, con un traceback de Python, que Volant no copia.
Mantiene cada variable donde se define en lugar de combinar las variables de grupo en cada host. --list da a cada grupo una entrada vars con sus propias variables y sus archivos group_vars. Cada host conserva solo lo que fijan su línea de inventario y sus archivos host_vars; las variables adicionales se omiten. Con --yaml no se comparte ningún valor, así que no aparecen anclas. Con --host solo se imprimen las variables propias de ese host. export = true en la sección [inventory] de ansible.cfg, o ANSIBLE_INVENTORY_EXPORT, lo activa por defecto. Con --graph --vars, las líneas de un host muestran solo sus propias variables.
Con --list, conserva solo los hosts que coinciden con el patrón. Los grupos se quedan, con sus hijos. Un patrón que no coincide con nada avisa e imprime un inventario sin hosts.
Donde estaría un playbook: se cargan los plugins de inventario y de caché de los directorios de plugins junto a él. ANSIBLE_PLAYBOOK_DIR también lo define.
Variables adicionales, añadidas a cada host y que ganan sobre todas las demás capas.
Escribe el documento en FILE y no imprime nada. El archivo contiene lo que habría salido por la salida estándar. Un documento JSON no tiene salto de línea final; un documento YAML o TOML conserva el suyo.
-i, -v y las opciones de vault funcionan como en volant playbook. Sin una acción elegida, el comando imprime No action selected, at least one of --host, --graph or --list needs to be specified., y con dos imprime Conflicting options used, only one of --host, --graph or --list can be used at the same time.; ambos salen con el código 5.