2012-09-26 18:41:44 +00:00
|
|
|
.. _@{ module }@:
|
|
|
|
|
2013-12-25 23:06:55 +00:00
|
|
|
{% if short_description %}
|
|
|
|
{% set title = module + ' - ' + short_description|convert_symbols_to_format %}
|
|
|
|
{% else %}
|
|
|
|
{% set title = module %}
|
|
|
|
{% endif %}
|
|
|
|
{% set title_len = title|length %}
|
|
|
|
|
|
|
|
@{ title }@
|
|
|
|
@{ '+' * title_len }@
|
|
|
|
|
2015-07-17 14:00:02 +00:00
|
|
|
{% if version_added is defined -%}
|
|
|
|
.. versionadded:: @{ version_added }@
|
|
|
|
{% endif %}
|
|
|
|
|
|
|
|
|
2013-12-25 19:05:43 +00:00
|
|
|
.. contents::
|
|
|
|
:local:
|
|
|
|
:depth: 1
|
2012-09-26 18:41:44 +00:00
|
|
|
|
|
|
|
{# ------------------------------------------
|
|
|
|
#
|
|
|
|
# Please note: this looks like a core dump
|
|
|
|
# but it isn't one.
|
|
|
|
#
|
|
|
|
--------------------------------------------#}
|
|
|
|
|
2014-10-30 17:29:54 +00:00
|
|
|
{% if deprecated is defined -%}
|
|
|
|
DEPRECATED
|
|
|
|
----------
|
|
|
|
|
|
|
|
@{ deprecated }@
|
|
|
|
{% endif %}
|
|
|
|
|
2013-12-25 19:05:43 +00:00
|
|
|
Synopsis
|
|
|
|
--------
|
|
|
|
|
2012-09-26 18:41:44 +00:00
|
|
|
{% for desc in description -%}
|
2016-11-01 19:59:47 +00:00
|
|
|
* @{ desc | convert_symbols_to_format }@
|
2012-09-26 18:41:44 +00:00
|
|
|
{% endfor %}
|
|
|
|
|
2015-07-17 14:00:02 +00:00
|
|
|
{% if aliases is defined -%}
|
|
|
|
Aliases: @{ ','.join(aliases) }@
|
|
|
|
{% endif %}
|
2015-06-04 02:19:26 +00:00
|
|
|
|
|
|
|
{% if requirements %}
|
2016-02-18 13:09:42 +00:00
|
|
|
Requirements (on host that executes module)
|
|
|
|
-------------------------------------------
|
2015-06-04 02:19:26 +00:00
|
|
|
|
|
|
|
{% for req in requirements %}
|
|
|
|
* @{ req | convert_symbols_to_format }@
|
|
|
|
{% endfor %}
|
|
|
|
{% endif %}
|
|
|
|
|
|
|
|
|
2012-09-30 11:20:24 +00:00
|
|
|
{% if options -%}
|
2013-12-25 19:05:43 +00:00
|
|
|
Options
|
|
|
|
-------
|
|
|
|
|
2012-09-28 01:06:31 +00:00
|
|
|
.. raw:: html
|
|
|
|
|
2013-12-25 19:06:15 +00:00
|
|
|
<table border=1 cellpadding=4>
|
2012-09-28 01:06:31 +00:00
|
|
|
<tr>
|
2012-09-28 07:59:43 +00:00
|
|
|
<th class="head">parameter</th>
|
|
|
|
<th class="head">required</th>
|
|
|
|
<th class="head">default</th>
|
|
|
|
<th class="head">choices</th>
|
|
|
|
<th class="head">comments</th>
|
2012-09-28 01:06:31 +00:00
|
|
|
</tr>
|
2012-11-03 22:52:59 +00:00
|
|
|
{% for k in option_keys %}
|
|
|
|
{% set v = options[k] %}
|
2012-09-28 01:06:31 +00:00
|
|
|
<tr>
|
2015-06-04 02:19:26 +00:00
|
|
|
<td>@{ k }@<br/><div style="font-size: small;">{% if v['version_added'] %} (added in @{v['version_added']}@){% endif %}</div></td>
|
2012-09-30 12:21:30 +00:00
|
|
|
<td>{% if v.get('required', False) %}yes{% else %}no{% endif %}</td>
|
2012-09-30 11:20:24 +00:00
|
|
|
<td>{% if v['default'] %}@{ v['default'] }@{% endif %}</td>
|
2013-06-01 16:33:11 +00:00
|
|
|
{% if v.get('type', 'not_bool') == 'bool' %}
|
|
|
|
<td><ul><li>yes</li><li>no</li></ul></td>
|
|
|
|
{% else %}
|
2012-09-28 01:06:31 +00:00
|
|
|
<td><ul>{% for choice in v.get('choices',[]) -%}<li>@{ choice }@</li>{% endfor -%}</ul></td>
|
2013-06-01 16:33:11 +00:00
|
|
|
{% endif %}
|
2016-11-02 23:48:07 +00:00
|
|
|
<td>{% for desc in v.description -%}<div>@{ desc | replace('\n', '\n ') | html_ify }@</div>{% endfor -%} {% if 'aliases' in v and v.aliases -%}</br>
|
2015-07-17 14:00:02 +00:00
|
|
|
<div style="font-size: small;">aliases: @{ v.aliases|join(', ') }@<div>{%- endif %}</td></tr>
|
2012-09-28 01:06:31 +00:00
|
|
|
{% endfor %}
|
|
|
|
</table>
|
2015-07-17 14:00:02 +00:00
|
|
|
</br>
|
2015-06-04 02:19:26 +00:00
|
|
|
|
2012-09-26 18:41:44 +00:00
|
|
|
{% endif %}
|
|
|
|
|
2013-05-11 14:31:47 +00:00
|
|
|
|
2015-06-04 02:19:26 +00:00
|
|
|
{% if examples or plainexamples -%}
|
2013-12-25 19:05:43 +00:00
|
|
|
Examples
|
|
|
|
--------
|
|
|
|
|
2015-07-17 14:00:02 +00:00
|
|
|
::
|
2012-09-28 01:30:32 +00:00
|
|
|
|
|
|
|
{% for example in examples %}
|
2015-07-17 14:00:02 +00:00
|
|
|
{% if example['description'] %}@{ example['description'] | indent(4, True) }@{% endif %}
|
2012-12-11 16:33:26 +00:00
|
|
|
@{ example['code'] | escape | indent(4, True) }@
|
2012-09-28 01:30:32 +00:00
|
|
|
{% endfor %}
|
2015-07-17 14:00:02 +00:00
|
|
|
{% if plainexamples %}@{ plainexamples | indent(4, True) }@{% endif %}
|
2013-12-25 19:05:43 +00:00
|
|
|
{% endif %}
|
2013-05-11 14:31:47 +00:00
|
|
|
|
2015-03-13 15:43:02 +00:00
|
|
|
|
2015-06-04 02:19:26 +00:00
|
|
|
{% if returndocs -%}
|
2015-03-13 15:43:02 +00:00
|
|
|
Return Values
|
|
|
|
-------------
|
|
|
|
|
2015-03-20 20:54:22 +00:00
|
|
|
Common return values are documented here :doc:`common_return_values`, the following are the fields unique to this module:
|
2015-03-13 15:43:02 +00:00
|
|
|
|
|
|
|
.. raw:: html
|
2015-03-13 16:17:15 +00:00
|
|
|
|
2015-03-20 20:54:22 +00:00
|
|
|
<table border=1 cellpadding=4>
|
|
|
|
<tr>
|
|
|
|
<th class="head">name</th>
|
2015-05-15 05:05:38 +00:00
|
|
|
<th class="head">description</th>
|
2015-03-20 20:54:22 +00:00
|
|
|
<th class="head">returned</th>
|
|
|
|
<th class="head">type</th>
|
|
|
|
<th class="head">sample</th>
|
|
|
|
</tr>
|
2015-03-13 15:43:02 +00:00
|
|
|
|
2015-03-20 20:54:22 +00:00
|
|
|
{% for entry in returndocs %}
|
|
|
|
<tr>
|
|
|
|
<td> @{ entry }@ </td>
|
|
|
|
<td> @{ returndocs[entry].description }@ </td>
|
|
|
|
<td align=center> @{ returndocs[entry].returned }@ </td>
|
|
|
|
<td align=center> @{ returndocs[entry].type }@ </td>
|
|
|
|
<td align=center> @{ returndocs[entry].sample}@ </td>
|
|
|
|
</tr>
|
|
|
|
{% if returndocs[entry].type == 'dictionary' %}
|
|
|
|
<tr><td>contains: </td>
|
|
|
|
<td colspan=4>
|
|
|
|
<table border=1 cellpadding=2>
|
|
|
|
<tr>
|
|
|
|
<th class="head">name</th>
|
2015-05-15 05:05:38 +00:00
|
|
|
<th class="head">description</th>
|
2015-03-20 20:54:22 +00:00
|
|
|
<th class="head">returned</th>
|
|
|
|
<th class="head">type</th>
|
|
|
|
<th class="head">sample</th>
|
|
|
|
</tr>
|
|
|
|
|
|
|
|
{% for sub in returndocs[entry].contains %}
|
|
|
|
<tr>
|
|
|
|
<td> @{ sub }@ </td>
|
|
|
|
<td> @{ returndocs[entry].contains[sub].description }@ </td>
|
|
|
|
<td align=center> @{ returndocs[entry].contains[sub].returned }@ </td>
|
|
|
|
<td align=center> @{ returndocs[entry].contains[sub].type }@ </td>
|
|
|
|
<td align=center> @{ returndocs[entry].contains[sub].sample}@ </td>
|
|
|
|
</tr>
|
|
|
|
{% endfor %}
|
|
|
|
|
|
|
|
</table>
|
|
|
|
</td></tr>
|
2015-03-13 16:17:15 +00:00
|
|
|
|
2015-03-20 20:54:22 +00:00
|
|
|
{% endif %}
|
|
|
|
{% endfor %}
|
|
|
|
|
|
|
|
</table>
|
|
|
|
</br></br>
|
2015-03-13 15:43:02 +00:00
|
|
|
{% endif %}
|
|
|
|
|
2015-06-04 02:19:26 +00:00
|
|
|
{% if notes -%}
|
|
|
|
Notes
|
|
|
|
-----
|
|
|
|
|
2013-12-25 19:06:15 +00:00
|
|
|
{% for note in notes %}
|
2013-12-25 19:05:43 +00:00
|
|
|
.. note:: @{ note | convert_symbols_to_format }@
|
2013-12-25 19:06:15 +00:00
|
|
|
{% endfor %}
|
2012-09-30 11:20:24 +00:00
|
|
|
{% endif %}
|
2012-09-28 01:30:32 +00:00
|
|
|
|
2014-10-31 18:18:18 +00:00
|
|
|
{% if not deprecated %}
|
2016-12-07 22:50:17 +00:00
|
|
|
Module Status: @{ ','.join(metadata.status) }@
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
{% if metadata.supported_by == 'core' %}
|
2014-09-26 22:23:57 +00:00
|
|
|
|
|
|
|
This is a Core Module
|
|
|
|
---------------------
|
|
|
|
|
2015-07-17 17:53:13 +00:00
|
|
|
For more information on what this means please read :doc:`modules_core`
|
2014-09-26 22:23:57 +00:00
|
|
|
|
2014-10-31 18:18:18 +00:00
|
|
|
{% else %}
|
2014-09-26 22:23:57 +00:00
|
|
|
|
2016-12-07 22:50:17 +00:00
|
|
|
This is module is supported by: @{ metadata.supported_by }@
|
2014-09-26 22:23:57 +00:00
|
|
|
------------------------
|
|
|
|
|
2015-07-17 17:53:13 +00:00
|
|
|
For more information on what this means please read :doc:`modules_extra`
|
2014-09-26 21:52:50 +00:00
|
|
|
|
2014-10-31 18:18:18 +00:00
|
|
|
{% endif %}
|
2014-09-26 21:52:50 +00:00
|
|
|
{% endif %}
|
|
|
|
|
|
|
|
For help in developing on modules, should you be so inclined, please read :doc:`community`, :doc:`developing_test_pr` and :doc:`developing_modules`.
|
|
|
|
|
|
|
|
|