From 1160c796719bb5cd1022a95f555a9f2691b35e56 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Fri, 12 Aug 2016 15:21:08 -0400 Subject: [PATCH] added meta as 'documentation' --- lib/ansible/modules/utilities/helper/meta.py | 64 ++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 lib/ansible/modules/utilities/helper/meta.py diff --git a/lib/ansible/modules/utilities/helper/meta.py b/lib/ansible/modules/utilities/helper/meta.py new file mode 100644 index 00000000000..6735bbc8e98 --- /dev/null +++ b/lib/ansible/modules/utilities/helper/meta.py @@ -0,0 +1,64 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# (c) 2016, Ansible, a Red Hat company +# +# 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 . + +DOCUMENTATION = ''' +module: meta +short_description: Execute Ansible 'actions' +version_added: "1.2" +description: + - Meta tasks are a special kind of task which can influence Ansible internal execution or state. Prior to Ansible 2.0, + the only meta option available was `flush_handlers`. As of 2.2, there are five meta tasks which can be used. + Meta tasks can be used anywhere within your playbook. +options: + free_form: + description: + - This module takes a free form command, as a string. There's not an actual option named "free form". See the examples! + - "C(flush_handlers) makes Ansible run any handler tasks which have thus far been notified. Ansible inserts these tasks internally at certain points to implicitly trigger handler runs (after pre/post tasks, the final role execution, and the main tasks section of your plays)." + - "C(refresh_inventory) (added in 2.0) forces the reload of the inventory, which in the case of dynamic inventory scripts means they will be re-executed. This is mainly useful when additional hosts are created and users wish to use them instead of using the `add_host` module." + - "C(noop) (added in 2.0) This literally does 'nothing'. It is mainly used internally and not recommended for general use." + - "C(clear_facts) (added in 2.1) causes the gathered facts for the hosts specified in the play's list of hosts to be cleared, including the fact cache." + - "C(clear_host_errors) (added in 2.1) clears the failed state (if any) from hosts specified in the play's list of hosts." + choices: ['noop', 'flush_handlers', 'refresh_inventory', 'clear_facts', 'clear_host_errors'] + required: true + default: null +notes: + - meta is not really a module nor action_plugin as such it cannot be overriden. +author: + - "Ansible Core Team" +''' + +EXAMPLES = ''' +# force all notified handlers to run at this point, not waiting for normal sync points +- template: src=new.j2 dest=/etc/config.txt + notify: myhandler +- meta: flush_handlers + +# reload inventory, useful with dynamic inventories when play makes changes to the existing hosts +- cloud_guest: name=newhost state=present # this is fake module +- meta: refresh_inventory + +# clear gathered facts from all currently targeted hosts +- meta: clear_facts + +# bring host back to play after failure +- copy: src=file dest=/etc/file + remote_user: imightnothavepermission +- meta: clear_host_errors +'''