.. _@{ module }@: {% 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 }@ {% if version_added is defined -%} .. versionadded:: @{ version_added }@ {% endif %} .. contents:: :local: :depth: 2 {# ------------------------------------------ # # Please note: this looks like a core dump # but it isn't one. # --------------------------------------------#} {% if deprecated is defined -%} DEPRECATED ---------- @{ deprecated | convert_symbols_to_format }@ {% endif %} Synopsis -------- {% for desc in description -%} * @{ desc | convert_symbols_to_format }@ {% endfor %} {% if aliases is defined -%} Aliases: @{ ','.join(aliases) }@ {% endif %} {% if requirements %} Requirements (on host that executes module) ------------------------------------------- {% for req in requirements %} * @{ req | convert_symbols_to_format }@ {% endfor %} {% endif %} {% if options -%} Options ------- .. raw:: html {% for k in option_keys -%} {% set v = options[k] -%} {% if not v['suboptions'] %} {% if v.get('type', 'not_bool') == 'bool' %} {% else %} {% endif %} {% endif %} {% endfor %}
parameter required default choices comments
@{ k }@
{% if v['version_added'] -%} (added in @{v['version_added']}@){% endif -%}
{% if v.get('required', False) -%}yes{% else %}no{% endif -%} {% if v['default'] -%}@{ v['default'] }@{% endif -%}
  • yes
  • no
{% if v['choices'] -%}
    {% for choice in v.get('choices',[]) -%}
  • @{ choice }@
  • {% endfor -%}
{% endif -%}
{% if v.description is string %}
@{ v.description | replace('\n', '\n ') | html_ify }@
{% else %} {% for desc in v.description %}
@{ desc | replace('\n', '\n ') | html_ify }@
{% endfor %} {% endif %} {% if 'aliases' in v and v.aliases %}
aliases: @{ v.aliases|join(', ') }@
{% endif %} {% else %}
@{ k }@
{% if v['version_added'] -%} (added in @{v['version_added']}@){% endif -%}
{% if v.get('required', False) -%}yes{% else -%}no{% endif -%} {% for desc in v.description %}
@{ desc | replace('\n', '\n ') | html_ify }@
{% endfor %} {% if 'aliases' in v and v.aliases %}
aliases: @{ v.aliases|join(', ') }@
{% endif %}
{% for k2 in v['suboptions'] %} {% set v2 = v['suboptions'] [k2] %} {% if v2.get('type', 'not_bool') == 'bool' %} {% else %} {% endif %} {% endfor %}
Dictionary object @{ k }@
parameter required default choices comments
@{ k2 }@
{% if v2['version_added'] -%} (added in @{v2['version_added']}@){% endif -%}
{% if v2.get('required', False) -%}yes{% else -%}no{% endif -%} {% if v2['default'] -%}@{ v2['default'] }@{% endif -%}
  • yes
  • no
{% if v2['choices'] -%}
    {% for choice in v2.get('choices',[]) -%}
  • @{ choice }@
  • {% endfor -%}
{% endif -%}
{% if v2.description is string %}
@{ v2.description | replace('\n', '\n ') | html_ify }@
{% else %} {% for desc in v2.description %}
@{ desc | replace('\n', '\n ') | html_ify }@
{% endfor %} {% endif %} {% if 'aliases' in v and v2.aliases %}
aliases: @{ v2.aliases|join(', ') }@
{% endif %}

{% endif %} {% if examples or plainexamples -%} Examples -------- :: {% for example in examples %} {% if example['description'] %}@{ example['description'] | indent(4, True) }@{% endif %} @{ example['code'] | escape | indent(4, True) }@ {% endfor %} {% if plainexamples %}@{ plainexamples | indent(4, True) }@{% endif %} {% endif %} {% if returndocs -%} Return Values ------------- Common return values are documented here :doc:`common_return_values`, the following are the fields unique to this module: .. raw:: html {% for entry in returndocs %} {% if returndocs[entry].type == 'complex' %} {% endif %} {% endfor %}
name description returned type sample
@{ entry }@ {% if returndocs[entry].description is string %}
@{ returndocs[entry].description | replace('\n', '\n ') | html_ify }@
{% else %} {% for desc in returndocs[entry].description %}
@{ desc | replace('\n', '\n ') | html_ify }@
{% endfor %} {% endif %}
@{ returndocs[entry].returned }@ @{ returndocs[entry].type }@ @{ returndocs[entry].sample | replace('\n', '\n ') | html_ify }@
contains: {% for sub in returndocs[entry].contains %} {% endfor %}
name description returned type sample
@{ sub }@ {% if returndocs[entry].contains[sub].description is string %}
@{ returndocs[entry].contains[sub].description | replace('\n', '\n ') | html_ify }@
{% else %} {% for desc in returndocs[entry].contains[sub].description %}
@{ desc | replace('\n', '\n ') | html_ify }@
{% endfor %} {% endif %}
@{ returndocs[entry].contains[sub].returned }@ @{ returndocs[entry].contains[sub].type }@ @{ returndocs[entry].contains[sub].sample }@


{% endif %} {% if notes -%} Notes ----- .. note:: {% for note in notes %} - @{ note | convert_symbols_to_format }@ {% endfor %} {% endif %} {% if not deprecated %} {% set support = { 'core': 'The Ansible Core Team', 'network': 'The Ansible Network Team', 'certified': 'an Ansible Partner', 'community': 'The Ansible Community', 'curated': 'A Third Party'} %} {% set module_states = { 'preview': 'it is not guaranteed to have a backwards compatible interface', 'stableinterface': 'the maintainers for this module guarantee that no backward incompatible interface changes will be made'} %} {% if metadata %} {% if metadata.status %} Status ~~~~~~ {% for cur_state in metadata.status %} This module is flagged as **@{cur_state}@** which means that @{module_states[cur_state]}@. {% endfor %} {% endif %} {% if metadata.supported_by %} Support Level ~~~~~~~~~~~~~ This module is maintained by @{ support[metadata.supported_by] }@ For more information on what this means please read :doc:`modules_support`. {% endif %} {% endif %} {% endif %} For help in developing on modules, should you be so inclined, please read :doc:`community`, :doc:`dev_guide/testing` and :doc:`dev_guide/developing_modules`.