ansible-console(1) - REPL console for executing Ansible tasks.



  • ANSIBLE-CONSOLE(1)			System administration commands			    ANSIBLE-CONSOLE(1)
    
    NAME
           ansible-console - REPL console for executing Ansible tasks.
    
    SYNOPSIS
           usage: ansible-console [-h] [--version] [-v] [-b]
    	      [--become-method	BECOME_METHOD]	[--become-user BECOME_USER] [-K] [-i INVENTORY] [--list-hosts]
    	      [-l SUBSET] [-k] [--private-key PRIVATE_KEY_FILE] [-u REMOTE_USER] [-c CONNECTION] [-T  TIMEOUT]
    	      [--ssh-common-args   SSH_COMMON_ARGS]   [--sftp-extra-args   SFTP_EXTRA_ARGS]  [--scp-extra-args
    	      SCP_EXTRA_ARGS]  [--ssh-extra-args  SSH_EXTRA_ARGS]  [-C]  [--syntax-check]   [-D]   [--vault-id
    	      VAULT_IDS]  [--ask-vault-pass  | --vault-password-file VAULT_PASSWORD_FILES] [-f FORKS] [-M MOD‐
    	      ULE_PATH] [--playbook-dir BASEDIR] [--step] [pattern]
    
    DESCRIPTION
           a REPL that allows for running ad-hoc tasks  against  a	chosen	inventory  (based  on  dominis'  ansi‐
           ble-shell).
    
    COMMON OPTIONS
    	  host pattern
    
           --ask-vault-pass
    	  ask for vault password
    
           --become-method 'BECOME_METHOD'
    	  privilege escalation method to use (default=%(default)s), use ansible-doc -t become -l to list valid
    	  choices.
    
           --become-user 'BECOME_USER'
    	  run operations as this user (default=root)
    
           --list-hosts
    	  outputs a list of matching hosts; does not execute anything else
    
           --playbook-dir 'BASEDIR'
    	  Since this tool does not use playbooks, use this as a substitute playbook  directory.This  sets  the
    	  relative path for many features including roles/ group_vars/ etc.
    
           --private-key 'PRIVATE_KEY_FILE', --key-file 'PRIVATE_KEY_FILE'
    	  use this file to authenticate the connection
    
           --scp-extra-args 'SCP_EXTRA_ARGS'
    	  specify extra arguments to pass to scp only (e.g. -l)
    
           --sftp-extra-args 'SFTP_EXTRA_ARGS'
    	  specify extra arguments to pass to sftp only (e.g. -f, -l)
    
           --ssh-common-args 'SSH_COMMON_ARGS'
    	  specify common arguments to pass to sftp/scp/ssh (e.g. ProxyCommand)
    
           --ssh-extra-args 'SSH_EXTRA_ARGS'
    	  specify extra arguments to pass to ssh only (e.g. -R)
    
           --step
    	  one-step-at-a-time: confirm each task before running
    
           --syntax-check
    	  perform a syntax check on the playbook, but do not execute it
    
           --vault-id
    	  the vault identity to use
    
           --vault-password-file
    	  vault password file
    
           --version
    	  show program's version number, config file location, configured module search path, module location,
    	  executable location and exit
    
           -C, --check
    	  don't make any changes; instead, try to predict some of the changes that may occur
    
           -D, --diff
    	  when changing (small) files and templates, show the differences in those  files;  works  great  with
    	  --check
    
           -K, --ask-become-pass
    	  ask for privilege escalation password
    
           -M, --module-path
    	  prepend    colon-separated	path(s)    to	 module    library    (default=~/.ansible/plugins/mod‐
    	  ules:/usr/share/ansible/plugins/modules)
    
           -T 'TIMEOUT', --timeout 'TIMEOUT'
    	  override the connection timeout in seconds (default=10)
    
           -b, --become
    	  run operations with become (does not imply password prompting)
    
           -c 'CONNECTION', --connection 'CONNECTION'
    	  connection type to use (default=smart)
    
           -f 'FORKS', --forks 'FORKS'
    	  specify number of parallel processes to use (default=5)
    
           -h, --help
    	  show this help message and exit
    
           -i, --inventory, --inventory-file
    	  specify inventory host path or comma separated host list. --inventory-file is deprecated
    
           -k, --ask-pass
    	  ask for connection password
    
           -l 'SUBSET', --limit 'SUBSET'
    	  further limit selected hosts to an additional pattern
    
           -u 'REMOTE_USER', --user 'REMOTE_USER'
    	  connect as this user (default=None)
    
           -v, --verbose
    	  verbose mode (-vvv for more, -vvvv to enable connection debugging)
    
    ENVIRONMENT
           The following environment variables may be specified.
    
           ANSIBLE_CONFIG -- Specify override location for the ansible config file
    
           Many more are available for most options in ansible.cfg
    
           For a full list check https://docs.ansible.com/. or use the ansible-config command.
    
    FILES
           /etc/ansible/ansible.cfg -- Config file, used if present
    
           ~/.ansible.cfg -- User config file, overrides the default config if present
    
           ./ansible.cfg -- Local config file (in current working directory) assumed to be 'project specific'  and
           overrides the rest if present.
    
           As mentioned above, the ANSIBLE_CONFIG environment variable will override all others.
    
    AUTHOR
           Ansible was originally written by Michael DeHaan.
    
    COPYRIGHT
           Copyright © 2018 Red Hat, Inc | Ansible.  Ansible is released under the terms of the GPLv3 license.
    
    SEE ALSO
           ansible	(1),  ansible-config  (1),  ansible-doc  (1), ansible-galaxy (1), ansible-inventory (1), ansi‐
           ble-playbook (1), ansible-pull (1), ansible-vault (1)
    
           Extensive documentation is available in the documentation site:	<https://docs.ansible.com>.   IRC  and
           mailing	  list	  info	  can	 be    found	in    file    CONTRIBUTING.md,	  available   in:   <‐
           https://github.com/ansible/ansible>
    
    Ansible 2.9.0.dev0									    ANSIBLE-CONSOLE(1)
    

Log in to reply
 

© Lightnetics 2019