volant adhoc
Ejecuta un módulo en cada host que coincide con un patrón, con las opciones y la salida de ansible.
volant adhoc es ansible: ejecuta un módulo en cada host que coincide con un patrón.
volant adhoc <PATTERN> [-m MODULE] [-a ARGS] [-i INV] [-e VARS] [-l SUBSET] [-f N] [-u USER] [-c CONN] [-T SECS] [-b --become-user --become-method -K --become-password-file] [-k --connection-password-file] [--private-key --ssh-common-args --ssh-extra-args] [-J --vault-id --vault-password-file] [-M PATH] [--list-hosts] [--flush-cache] [--playbook-dir DIR] [-C] [-D] [-o] [-t DIR] [-B SECONDS] [-P SECONDS] [--task-timeout SECONDS] [--version] [-v]El módulo que se ejecuta. Por defecto: command.
Los argumentos del módulo: palabras key=value, o un objeto JSON cuando el valor empieza por { y termina en }. Para command, shell, raw y script, las palabras que no son una opción del módulo forman la línea de comandos. Los argumentos se renderizan como plantilla con las variables de cada host y -e. Un valor que empieza por {, termina en } y no es JSON válido detiene el comando con el código de salida 250; una comilla sin cerrar lo detiene con el código 4.
Ejecuta la tarea en modo check. Un módulo que no puede comprobar informa SKIPPED.
Imprime, antes de su resultado, las diferencias que una tarea hace en archivos y plantillas. Con -C el archivo no se modifica.
Imprime una línea por host, como lo hace el callback oneline de ansible. ansible-core 2.19.12 declara obsoleta esta opción y avisa en el error estándar; véase más abajo.
Escribe además el resultado de cada host en un archivo de DIR con el nombre del host, como lo hace el callback tree de ansible. ansible-core 2.19.12 declara obsoleta esta opción y avisa en el error estándar; véase más abajo.
Ejecuta el módulo como un trabajo asíncrono que tiene este número de segundos para terminar, y lo consulta. El resultado lleva ansible_job_id, started, finished y results_file, y el async_val del diccionario Origin: es este valor. Sin -B, -P se ignora.
Segundos entre dos consultas del trabajo de -B. Por defecto: 15. Con 0 el trabajo solo se inicia, y el resultado lleva "finished": false. El poll del diccionario Origin: es este valor.
Hace fallar una tarea que dura más de este número de segundos, con el código de salida 2 y el mensaje Task failed: Timed out after N second(s).. 0 significa sin límite, y un valor superior a 100000000 hace fallar la tarea con Timeout N is invalid, it must be between 0 and 100000000.. El timeout del diccionario Origin: es este valor.
Imprime ansible [core 2.19.12], el archivo de configuración, la ruta de búsqueda de módulos, la ubicación de las colecciones y la ubicación del ejecutable, y se detiene. La ubicación del ejecutable sigue a argv[0]: un argv[0] relativo, o uno fijado con exec -a, puede nombrar un archivo distinto del que se ejecuta. Cuando Volant encuentra un intérprete con ansible-core, siguen la ubicación de los módulos y las versiones de Python, Jinja y PyYAML, en las líneas de la referencia. Sin él, esas líneas se omiten: --version no instala nada. Las rutas de búsqueda leen el entorno y los valores por defecto, no library ni collections_path de ansible.cfg.
Muestra los hosts que el patrón designa, como hosts (2): y una línea nombre por host, y no ejecuta nada. El código de salida es 0.
Lee group_vars/, host_vars/, las rutas relativas y los roles desde DIR, y fija playbook_dir en él, donde un playbook habría aportado su propio directorio. Por defecto: el directorio de trabajo.
Las demás opciones significan lo mismo que para volant playbook, incluidas --flush-cache y -M. -f 1 ejecuta un host cada vez, en el orden del inventario.
Un patrón que no designa ningún host imprime [WARNING]: Could not match supplied host pattern, ignoring: PATTERN y [WARNING]: No hosts matched, nothing to do en la salida de error estándar, y termina con 0. Un -l que no deja ningún host imprime [ERROR]: Specified inventory, host pattern and/or --limit leaves us with no hosts to target. y termina con 1, con o sin --list-hosts. Un aviso de que el patrón de -l no se pudo resolver va antes solo cuando ese patrón no designa ningún host. Un inventario sin ningún host avisa una vez y no ejecuta nada. Sin inventario, el localhost implícito es el único host que existe, y solo lo designa un patrón que lo nombre. Un command, shell o raw sin -a se detiene con [ERROR]: No argument passed to command module y el código de salida 5.
Un error de uso termina con 2. La salida de error estándar lleva el bloque usage: de ansible, luego ansible: error: y el motivo. Tras un patrón que falta o un -f que no es un número sigue la ayuda completa de ansible; tras un -f menor que 1, no.
Cada host imprime un resultado, como lo imprime el callback minimal de ansible. Un resultado de command, shell o raw es h1 | CHANGED | rc=0 >>, y a continuación su stdout, su stderr y su msg unidos sin nada entre ellos. Cualquier otro resultado es h1 | SUCCESS => seguido del resultado como JSON, con sangría de cuatro espacios y las claves ordenadas. Los estados son SUCCESS, CHANGED, FAILED (forma de comando), FAILED! (forma JSON), SKIPPED y UNREACHABLE!. Antes de un resultado fallido o inalcanzable, la salida estándar lleva el mismo bloque [ERROR] que imprime un playbook. Su Origin: es <adhoc 'MODULE' task>, seguido de la tarea tal como la muestra ansible, recortada a 120 caracteres.
El código de salida es 0 cuando todos los hosts tuvieron éxito o se omitieron, 2 cuando un host falló, y 4 cuando no se pudo alcanzar un host, haya o no hosts fallidos. ANSIBLE_STDOUT_CALLBACK solo cambia la salida cuando bin_ansible_callbacks está activado (ANSIBLE_LOAD_CALLBACK_PLUGINS=true) y nombra un callback distinto de default: entonces oneline imprime como -o, y un nombre que Volant no tiene detiene el comando con Could not load. -o tiene prioridad. Con ANSIBLE_CALLBACK_RESULT_FORMAT=yaml, o callback_result_format = yaml bajo [defaults] en ansible.cfg, un resultado de forma JSON se imprime en cambio como YAML, en las líneas después de =>, con sangría de cuatro espacios. Una cadena con saltos de línea se convierte en un bloque literal. Cualquier otro valor, incluido el vacío, detiene el comando con el código de salida 5.
Una línea por host
Sección titulada «Una línea por host»Con -o, un resultado de command, shell o raw es h1 | CHANGED | rc=0 | (stdout) hi, con sus saltos de línea escritos \n, y (stderr) text a continuación cuando lo hay. Cualquier otro resultado es h1 | SUCCESS => y el resultado como JSON en una línea, con las claves ordenadas y separadas por , sin espacio detrás. Un resultado que pide la forma con sangría, como debug, o cualquier resultado con -vvv, conserva sus cuatro espacios, sin saltos de línea. Un host que falla imprime los mismos dos tipos de línea, con FAILED, y para un comando la forma de comando va primero, luego la línea FAILED!. Cuando el fallo lleva una excepción, una línea An exception occurred during task execution. To see the full traceback, use -vvv. The error was: ... va primero; con -vvv contiene el texto completo. Un host inalcanzable imprime h1 | UNREACHABLE!: y su mensaje. -o no imprime bloque [ERROR], ni avisos de un resultado, ni diff, y no lee callback_result_format. Los códigos de salida son los mismos que sin ella.
Con -t DIR la salida no cambia. DIR se crea cuando llega el primer resultado, ~ se expande, y una ruta relativa parte del directorio de trabajo. Cada resultado que no es una omisión se escribe en DIR/HOST como JSON en una línea, con las claves ordenadas, sin salto de línea al final, sobre lo que dejó el resultado anterior del host; un host inalcanzable también recibe un archivo. Un resultado de debug, y cualquier resultado con -vvv, se escribe con sangría. El archivo se reemplaza, no se escribe sobre el existente: un enlace colocado en su lugar se reemplaza, y el modo es 0600. Un nombre de host que no es un simple nombre de archivo (vacío, ., .. o con una /) imprime un [WARNING] y no obtiene archivo, mientras que ansible-core escribe donde apunte el nombre, incluidos ../x y las rutas absolutas. Un directorio que no se puede crear, o un archivo que no se puede escribir, imprime un [WARNING] y la ejecución continúa. Un $ en DIR, o ~ seguido de un nombre de usuario, detiene el comando con el código de salida 4 y dice que todavía no se admite.
Ambas opciones imprimen estas líneas en el error estándar antes del primer resultado, en este orden: el [WARNING] que dice cómo desactivar los avisos de obsolescencia, un [DEPRECATION WARNING] por opción, escrito y ordenado como lo dio la línea de comandos (-o y -t en un mismo grupo de opciones cortas cuentan como dos), los avisos del patrón de hosts, y un [DEPRECATION WARNING] para el callback oneline y otro para el callback tree. Una ejecución que termina antes de que se carguen los callbacks (--list-hosts, un -l que no deja ningún host) imprime solo los dos primeros grupos. deprecation_warnings = False o ANSIBLE_DEPRECATION_WARNINGS=false los silencia todos. Con -vv, -o aparta minimal, donde la salida por defecto aparta oneline; con -vvvv, -t añade una línea para el callback tree.
Acciones que no son módulos
Sección titulada «Acciones que no son módulos»set_fact imprime sus ansible_facts como cualquier resultado de módulo. meta con noop, flush_handlers, clear_facts, refresh_inventory, reset_connection o end_host no imprime nada y sale con 0, y con end_play se detiene con Unexpected Exception, this is probably a bug: 0 y el código de salida 250, como la referencia, sin su traza. Estas diferencias con ansible-core 2.19.12 se mantienen:
metacon una acción desconocida, o sin-a, se detiene con el código de salida 1 como la referencia, pero su bloque[ERROR]no termina con la línea en blanco que imprime la referencia, y sin-anombra el argumento de otra manera.- El
[ERROR]de uninclude_roleo uninclude_tasksque no puede cargar su rol o su archivo se redacta de otra forma. Los códigos de salida coinciden: 2 para estos dos, 1 paraimport_roleeimport_tasks. group_byinformaSUCCESScon"changed": falsedonde la referencia informaCHANGED.
Salida detallada
Sección titulada «Salida detallada»-vv empieza con el bloque que imprime --version, luego Using PATH as config file (o No config file found; using defaults), y las líneas Skipping callback 'default', as we already have a stdout callback. y Skipping callback 'oneline', as we already have a stdout callback. (minimal en lugar de oneline con -o). -vvv y superiores añaden las líneas de los plugins de inventario y las que imprime volant playbook; las líneas propias de la referencia ESTABLISH LOCAL CONNECTION y EXEC describen su subida de módulos, que Volant no hace, así que no se imprimen.
Un -B, -P o --task-timeout negativo, y -C junto con -B, detienen el comando con el código de salida 4 y dicen qué no se admite todavía. -B, -P y --task-timeout toman un número entero; cualquier otra cosa es un error de uso.