Ir al contenido
Instalar

Línea de comandos

Todos los comandos y opciones que acepta Volant, agrupados por lo que cambian, y las opciones de ansible-playbook que todavía no tiene.

Ventana de terminal
volant playbook [OPTIONS] <PLAYBOOK>...
volant-playbook [OPTIONS] <PLAYBOOK>...
volant adhoc [OPTIONS] <PATTERN>
volant config [ARGS...]
volant console [pattern] [OPTIONS]
volant doc [ARGS...]
volant galaxy [ARGS...]
volant pull -U URL [OPTIONS] [PLAYBOOK...]
volant inventory (--list | --host HOST) [OPTIONS]
volant runtime <install|pack|status|path|remove>
volant shadow replay RECORDING [--json]
volant compat install [-p PATH] [-f]
volant lock [--check]
volant shims <install|remove>
volant vault <encrypt|decrypt|view|create|edit|rekey|encrypt_string>
volant --version

Cada uno de los demás comandos tiene su propia página: volant adhoc, volant check, volant config, volant compat, volant console, volant doc, volant galaxy, volant pull, volant inventory, volant lock, volant runtime, volant shadow, volant shims, volant vault. Nombres de comandos de ansible los une. Esta página trata de volant playbook.

volant playbook acepta las mismas opciones que ansible-playbook, en las que existen. volant-playbook es el mismo programa con un nombre que se parece al que conoces. Los playbooks que se pasan juntos se ejecutan en orden, y cada uno imprime su propio recap.

En Linux y macOS, el binario volant también se comporta según el nombre con el que se inició (el nombre de archivo de argv[0]). Iniciado como ansible-playbook, ansible-vault, ansible-doc, ansible-config, ansible-galaxy, ansible-console, ansible-pull o ansible-inventory, mediante un enlace simbólico o un enlace duro, se comporta como volant playbook, volant vault, volant doc, volant config, volant galaxy, volant console, volant pull o volant inventory, con los mismos argumentos, la misma salida y los mismos códigos de salida. Iniciado como ansible, se comporta como volant adhoc. volant doc y config ejecutan las herramientas propias de ansible-core desde el runtime de Python de Volant. volant galaxy se está haciendo nativo y rechaza cada subcomando hasta que lo sea. volant pull y volant console son propios de Volant; volant pull y volant console indican en qué difieren. Un error de uso sale con 2 y nombra el programa tal como se inició. Cualquier otro nombre conserva el comportamiento habitual de volant.

Cuando una opción tiene una clave de ansible.cfg o una variable de entorno, la entrada la nombra. La opción gana a ambas; Configuración explica el orden.

Una fuente de inventario: un archivo, un directorio, un script o una lista de hosts separada por comas. Repítela para combinar varias, consulta Inventarios. Sin ella, solo existe el localhost implícito.

ansible.cfg
[defaults] inventory
Environment
ANSIBLE_INVENTORY

Ejecuta solo en los hosts que coinciden con este patrón. Un límite que no coincide con ningún host emite un aviso y reduce la ejecución a lo que sí coincidió.

Empieza en la primera tarea llamada NAME; * y ? coinciden con cualquier texto. Se omiten las tareas anteriores, salvo Gathering Facts, y también los plays anteriores al que la contiene. Solo se buscan las tareas escritas en el play, como en ansible-playbook: una tarea que un include_tasks o un include_role lee durante la ejecución no se encuentra. Un nombre que no coincide con nada imprime los plays con un recap vacío, después un error, y sale con 0.

Pregunta antes de cada tarea: y la ejecuta, n o cualquier otra cosa la omite, c la ejecuta junto con todas las siguientes sin preguntar. Necesita un terminal; sin él la ejecución se detiene con código de salida 250 antes de tocar ningún host.

Elimina antes de la ejecución las entradas de la caché de facts de los hosts del inventario.

Imprime la versión de Volant y la versión de ansible-core a la que corresponde, y termina.

Inicia sesión en los hosts con este usuario. Sin ella, ssh elige el usuario, a partir de tu ~/.ssh/config o de tu cuenta local.

ansible.cfg
[defaults] remote_user
Environment
ANSIBLE_REMOTE_USER

El plugin de conexión de los hosts que no nombran ninguno: ssh o local. El ansible_connection de un host y la palabra clave connection de un play, bloque o tarea ganan a esta opción. Cualquier otro nombre hace fallar la tarea con the connection plugin '<name>' was not found.

La clave privada con la que se autentica ssh, pasada como ssh -i.

ansible.cfg
[defaults] private_key_file
Environment
ANSIBLE_PRIVATE_KEY_FILE

Argumentos que se añaden a cada línea de comandos de ssh. Volant los divide en palabras como lo haría un shell, y una comilla sin cerrar detiene la ejecución antes de empezar. La variable de host ansible_ssh_common_args sustituye este valor para ese host.

Argumentos que se añaden a la línea de comandos de ssh después de los comunes. La variable de host ansible_ssh_extra_args sustituye este valor para ese host.

Cuánto esperar una conexión, pasado a ssh como ConnectTimeout.

Default
10
ansible.cfg
[defaults] timeout
Environment
ANSIBLE_TIMEOUT

En cuántos hosts trabaja un play a la vez. Cero o un valor que no sea un número se rechaza antes de empezar la ejecución.

Default
5
ansible.cfg
[defaults] forks
Environment
ANSIBLE_FORKS

Directorios en los que se buscan módulos antes que en los configurados. Separados por dos puntos y repetible. Un -M posterior va delante de uno anterior.

Variables adicionales, en lo más alto del orden de precedencia: pares key=value, JSON o YAML en línea, o @file. Repetible.

Ejecuta solo las tareas con estas etiquetas. Separadas por comas y repetible, y se suma al valor por defecto configurado en lugar de sustituirlo. Consulta Etiquetas.

ansible.cfg
[tags] run
Environment
ANSIBLE_RUN_TAGS

Omite las tareas con estas etiquetas. Separadas por comas y repetible, y se suma al valor por defecto configurado.

ansible.cfg
[tags] skip
Environment
ANSIBLE_SKIP_TAGS

Estas opciones leen los playbooks y terminan. Nunca se conectan a un host y nunca se detienen ante un módulo no admitido, así que funcionan con playbooks que esta versión todavía no puede ejecutar.

Enumera las tareas que ejecutaría la ejecución, en el formato de Ansible.

Enumera las etiquetas que seleccionaría la ejecución.

Enumera los hosts en los que se ejecutaría cada play, en el orden del inventario.

Carga y compila los playbooks sin ejecutar nada.

Ejecuta las tareas con escalado de privilegios. Una palabra clave become del playbook sigue decidiendo en su propio play, bloque o tarea. Consulta Escalado de privilegios.

Default
false
ansible.cfg
[privilege_escalation] become
Environment
ANSIBLE_BECOME

El usuario al que se escala.

Default
root
ansible.cfg
[privilege_escalation] become_user
Environment
ANSIBLE_BECOME_USER

El método de escalado: sudo o su. Otros métodos detienen la ejecución antes de empezar.

Default
sudo
ansible.cfg
[privilege_escalation] become_method
Environment
ANSIBLE_BECOME_METHOD

Pide la contraseña de SSH en el terminal, con el eco desactivado. ssh la recibe mediante SSH_ASKPASS, así que necesita OpenSSH 8.4 o posterior. La contraseña no aparece en ninguna línea de comandos, en ningún entorno enviado al host ni en ningún log. Después de -k, una respuesta vacía al prompt de -K reutiliza la contraseña de SSH, como en ansible-playbook.

Lee la contraseña de SSH de la primera línea de este archivo. Es incompatible con -k.

Lee la contraseña del escalado de la primera línea de este archivo. Es incompatible con -K.

Pide la contraseña del escalado en el terminal, con el eco desactivado. La contraseña se escribe una sola vez en sudo y no aparece en ninguna línea de comandos, log ni resultado.

Pide la contraseña de vault en el terminal, con el eco desactivado.

Un archivo que contiene la contraseña de vault, o un ejecutable que la imprime. Repetible.

ansible.cfg
[defaults] vault_password_file
Environment
ANSIBLE_VAULT_PASSWORD_FILE

Una identidad de vault: la fuente es un archivo, un ejecutable o prompt. Repetible. Cada contraseña se prueba con cada valor cifrado, sea cual sea su etiqueta. Consulta Vault.

ansible.cfg
[defaults] vault_identity_list
Environment
ANSIBLE_VAULT_IDENTITY_LIST

Ejecuta los handlers notificados incluso en los hosts que fallaron. Una palabra clave force_handlers del play tiene prioridad. Consulta Handlers.

Default
false
ansible.cfg
[defaults] force_handlers
Environment
ANSIBLE_FORCE_HANDLERS

Informa de lo que cambiaría cada tarea sin cambiarlo. La palabra clave check_mode de una tarea gana a esta opción, así que una tarea con check_mode: false se ejecuta de verdad. Un host sin Python no puede responder a apt, user, group ni file con --check o --diff: esos módulos lo necesitan y la tarea falla. Consulta Modo check, diff y listados.

Default
false

Imprime los cambios que los módulos hacen en los archivos, como hace ansible-playbook. La palabra clave diff de una tarea gana a esta opción, así que diff: false mantiene fuera de la pantalla los cambios de una tarea. Un host sin Python no puede responder a apt, user, group ni file con --diff: esos módulos lo necesitan y la tarea falla. Consulta Modo check, diff y listados.

Default
false

Muestra también los resultados de módulo de las tareas correctas. Repetible, como el -vvv de Ansible. Un resultado lleva su clave invocation, con los argumentos que recibió el módulo, solo a partir de -vvv. Con -vvvv la ejecución imprime además todas las opciones que recibió, los plugins que carga y los comandos ssh que ejecuta.

Imprime sin colores. La opción gana a force_color (ANSIBLE_FORCE_COLOR), que gana a nocolor. Consulta Configuración.

ansible.cfg
[defaults] nocolor
Environment
ANSIBLE_NOCOLOR

De dónde salen los facts recopilados. auto usa el setup nativo del agente cuando todos los facts que pueden leer los plays son de los que produce, y el módulo setup de ansible-core en caso contrario. python ejecuta siempre el módulo de Python, para comparar. native pregunta siempre al recopilador del agente, y los facts que no produce quedan entonces sin definir. En un host que no sea Debian ni Ubuntu, el recopilador nativo devuelve la tarea al módulo de Python diga lo que diga esta opción. Consulta Facts.

Default
auto

Rechaza la ejecución con la salida 4, antes de cualquier conexión, cuando las colecciones, roles, runtime o Volant instalados difieren de volant.lock. Sin ella, cada diferencia es un aviso.

Después del recap, imprime en la salida de error en qué se fue el tiempo de la ejecución: las fases del controlador por host y, para cada módulo, el camino que siguieron sus tareas (native, python o fallback), sus tiempos y por qué un módulo nativo devolvió una tarea. La primera línea dice de dónde salieron los facts y por qué.

Volant lee las variables ANSIBLE_* nombradas arriba, además de algunas propias.

El intérprete de Python que usa el controlador para construir los payloads de módulos. Necesita ansible-core. Cuando está definida, Volant usa solo ese intérprete y no instala nada. Qué intérprete usa una ejecución da el orden completo.

Si Volant puede usar e instalar su propio Python. Consulta El runtime administrado.

ansible.cfg
[volant] runtime

Un directorio que contiene los binarios del agente. Se comprueba primero, antes que los agentes integrados en el controlador de la versión y el directorio del ejecutable volant. Es útil con un controlador compilado desde el código fuente, o para probar un agente propio.

ansible.cfg
[volant] batching

Cómo se trata un src del controlador que nombró un host administrado. Consulta host_named_paths.

ansible.cfg
[volant] host_named_paths

Los directorios del controlador bajo los que un fetch puede escribir cuando un host administrado nombró su dest. Consulta host_named_dest_dirs.

ansible.cfg
[volant] host_named_dest_dirs

Con 0, todas las tareas ejecutan el módulo de Python de ansible-core en lugar de la versión nativa del agente. Consulta Módulos nativos.

ansible.cfg
[volant] native_modules

Con 0, cada ejecución de ssh abre su propia conexión en lugar de compartir una por host del inventario.

ansible.cfg
[volant] ssh_control_master

Escribe el perfil de la ejecución en este archivo, un objeto JSON por línea: los módulos nativos que informó cada agente, después las fases y después una línea por tarea con su módulo, su camino, el motivo de la devolución y sus tiempos en microsegundos. Se escribe pase lo que pase con la ejecución, y un archivo que no se puede escribir solo imprime un aviso.

Se acepta cada opción de ansible-playbook. --scp-extra-args y --sftp-extra-args no tienen efecto, porque los archivos viajan por el enlace con el agente. La página de paridad enumera cada opción con su estado.

volant tiene los subcomandos playbook, adhoc, check, inventory, runtime, lock, shadow, shims, compat, vault, doc, config, galaxy, console y pull. No hay volant lint: usa ansible-lint para eso. volant check dice si Volant puede ejecutar un playbook. No es --check, que ejecuta el playbook en modo de comprobación contra los hosts.