summaryrefslogtreecommitdiff
path: root/lib/ansible/cli/adhoc.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/cli/adhoc.py')
-rw-r--r--lib/ansible/cli/adhoc.py156
1 files changed, 156 insertions, 0 deletions
diff --git a/lib/ansible/cli/adhoc.py b/lib/ansible/cli/adhoc.py
new file mode 100644
index 0000000000..16c2dc9e42
--- /dev/null
+++ b/lib/ansible/cli/adhoc.py
@@ -0,0 +1,156 @@
+# (c) 2012, Michael DeHaan <michael.dehaan@gmail.com>
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
+
+########################################################
+from ansible import constants as C
+from ansible.errors import AnsibleError, AnsibleOptionsError
+from ansible.executor.task_queue_manager import TaskQueueManager
+from ansible.inventory import Inventory
+from ansible.parsing import DataLoader
+from ansible.parsing.splitter import parse_kv
+from ansible.playbook.play import Play
+from ansible.cli import CLI
+from ansible.utils.display import Display
+from ansible.utils.vault import read_vault_file
+from ansible.vars import VariableManager
+
+########################################################
+
+class AdHocCLI(CLI):
+ ''' code behind ansible ad-hoc cli'''
+
+ def parse(self):
+ ''' create an options parser for bin/ansible '''
+
+ self.parser = CLI.base_parser(
+ usage='%prog <host-pattern> [options]',
+ runas_opts=True,
+ async_opts=True,
+ output_opts=True,
+ connect_opts=True,
+ check_opts=True,
+ runtask_opts=True,
+ vault_opts=True,
+ )
+
+ # options unique to ansible ad-hoc
+ self.parser.add_option('-a', '--args', dest='module_args',
+ help="module arguments", default=C.DEFAULT_MODULE_ARGS)
+ self.parser.add_option('-m', '--module-name', dest='module_name',
+ help="module name to execute (default=%s)" % C.DEFAULT_MODULE_NAME,
+ default=C.DEFAULT_MODULE_NAME)
+
+ self.options, self.args = self.parser.parse_args()
+
+ if len(self.args) != 1:
+ raise AnsibleOptionsError("Missing target hosts")
+
+ self.display.verbosity = self.options.verbosity
+ self.validate_conflicts()
+
+ return True
+
+
+ def run(self):
+ ''' use Runner lib to do SSH things '''
+
+ # only thing left should be host pattern
+ pattern = self.args[0]
+
+ # ignore connection password cause we are local
+ if self.options.connection == "local":
+ self.options.ask_pass = False
+
+ sshpass = None
+ becomepass = None
+ vault_pass = None
+
+ self.normalize_become_options()
+ (sshpass, becomepass) = self.ask_passwords()
+ passwords = { 'conn_pass': sshpass, 'become_pass': becomepass }
+
+ if self.options.vault_password_file:
+ # read vault_pass from a file
+ vault_pass = read_vault_file(self.options.vault_password_file)
+ elif self.options.ask_vault_pass:
+ vault_pass = self.ask_vault_passwords(ask_vault_pass=True, ask_new_vault_pass=False, confirm_new=False)[0]
+
+ loader = DataLoader(vault_password=vault_pass)
+ variable_manager = VariableManager()
+
+ inventory = Inventory(loader=loader, variable_manager=variable_manager, host_list=self.options.inventory)
+
+ hosts = inventory.list_hosts(pattern)
+ if len(hosts) == 0:
+ self.display.warning("provided hosts list is empty, only localhost is available")
+
+ if self.options.listhosts:
+ for host in hosts:
+ self.display.display(' %s' % host)
+ return 0
+
+ if self.options.module_name in C.MODULE_REQUIRE_ARGS and not self.options.module_args:
+ raise AnsibleError("No argument passed to %s module" % self.options.module_name)
+
+ #TODO: implement async support
+ #if self.options.seconds:
+ # callbacks.display("background launch...\n\n", color='cyan')
+ # results, poller = runner.run_async(self.options.seconds)
+ # results = self.poll_while_needed(poller)
+ #else:
+ # results = runner.run()
+
+ # create a pseudo-play to execute the specified module via a single task
+ play_ds = dict(
+ name = "Ansible Ad-Hoc",
+ hosts = pattern,
+ gather_facts = 'no',
+ tasks = [ dict(action=dict(module=self.options.module_name, args=parse_kv(self.options.module_args))), ]
+ )
+
+ play = Play().load(play_ds, variable_manager=variable_manager, loader=loader)
+
+ # now create a task queue manager to execute the play
+ tqm = None
+ try:
+ tqm = TaskQueueManager(
+ inventory=inventory,
+ variable_manager=variable_manager,
+ loader=loader,
+ display=self.display,
+ options=self.options,
+ passwords=passwords,
+ stdout_callback='minimal',
+ )
+ result = tqm.run(play)
+ finally:
+ if tqm:
+ tqm.cleanup()
+
+ return result
+
+ # ----------------------------------------------
+
+ def poll_while_needed(self, poller):
+ ''' summarize results from Runner '''
+
+ # BACKGROUND POLL LOGIC when -B and -P are specified
+ if self.options.seconds and self.options.poll_interval > 0:
+ poller.wait(self.options.seconds, self.options.poll_interval)
+
+ return poller.results
+