|
| 1 | + |
| 2 | +.. Document meta |
| 3 | +
|
| 4 | +:orphan: |
| 5 | +:github_url: https://github.com/ansible-community/antsibull-docs/edit/main/tests/functional/collections/ansible_collections/ns2/col/plugins/lookup/bar.py?description=%23%23%23%23%23%20SUMMARY%0A%3C!---%20Your%20description%20here%20--%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr |
| 6 | + |
| 7 | +.. |antsibull-internal-nbsp| unicode:: 0xA0 |
| 8 | + :trim: |
| 9 | + |
| 10 | +.. role:: ansible-attribute-support-label |
| 11 | +.. role:: ansible-attribute-support-property |
| 12 | +.. role:: ansible-attribute-support-full |
| 13 | +.. role:: ansible-attribute-support-partial |
| 14 | +.. role:: ansible-attribute-support-none |
| 15 | +.. role:: ansible-attribute-support-na |
| 16 | +.. role:: ansible-option-type |
| 17 | +.. role:: ansible-option-elements |
| 18 | +.. role:: ansible-option-required |
| 19 | +.. role:: ansible-option-versionadded |
| 20 | +.. role:: ansible-option-aliases |
| 21 | +.. role:: ansible-option-choices |
| 22 | +.. role:: ansible-option-choices-default-mark |
| 23 | +.. role:: ansible-option-default-bold |
| 24 | +.. role:: ansible-option-configuration |
| 25 | +.. role:: ansible-option-returned-bold |
| 26 | +.. role:: ansible-option-sample-bold |
| 27 | + |
| 28 | +.. Anchors |
| 29 | +
|
| 30 | +.. _ansible_collections.ns2.col.bar_lookup: |
| 31 | + |
| 32 | +.. Anchors: short name for ansible.builtin |
| 33 | +
|
| 34 | +.. Anchors: aliases |
| 35 | +
|
| 36 | +
|
| 37 | +
|
| 38 | +.. Title |
| 39 | +
|
| 40 | +ns2.col.bar lookup -- Look up some bar |
| 41 | +++++++++++++++++++++++++++++++++++++++ |
| 42 | + |
| 43 | +.. Collection note |
| 44 | +
|
| 45 | +.. note:: |
| 46 | + This lookup plugin is part of the `ns2.col collection <https://galaxy.ansible.com/ns2/col>`_ (version 2.1.0). |
| 47 | + |
| 48 | + To install it, use: :code:`ansible-galaxy collection install ns2.col`. |
| 49 | + |
| 50 | + To use it in a playbook, specify: :code:`ns2.col.bar`. |
| 51 | + |
| 52 | +.. version_added |
| 53 | +
|
| 54 | +.. rst-class:: ansible-version-added |
| 55 | + |
| 56 | +New in ns2.col 1.0.0 |
| 57 | + |
| 58 | +.. contents:: |
| 59 | + :local: |
| 60 | + :depth: 1 |
| 61 | + |
| 62 | +.. Deprecated |
| 63 | +
|
| 64 | +
|
| 65 | +Synopsis |
| 66 | +-------- |
| 67 | + |
| 68 | +.. Description |
| 69 | +
|
| 70 | +- This one is private. |
| 71 | + |
| 72 | + |
| 73 | +.. Aliases |
| 74 | +
|
| 75 | +
|
| 76 | +.. Requirements |
| 77 | +
|
| 78 | +
|
| 79 | +
|
| 80 | +
|
| 81 | +.. Terms |
| 82 | +
|
| 83 | +Terms |
| 84 | +----- |
| 85 | + |
| 86 | +.. rst-class:: ansible-option-table |
| 87 | + |
| 88 | +.. list-table:: |
| 89 | + :width: 100% |
| 90 | + :widths: auto |
| 91 | + :header-rows: 1 |
| 92 | + |
| 93 | + * - Parameter |
| 94 | + - Comments |
| 95 | + |
| 96 | + * - .. raw:: html |
| 97 | + |
| 98 | + <div class="ansible-option-cell"> |
| 99 | + <div class="ansibleOptionAnchor" id="parameter-_terms"></div> |
| 100 | + |
| 101 | + .. _ansible_collections.ns2.col.bar_lookup__parameter-_terms: |
| 102 | + |
| 103 | + .. rst-class:: ansible-option-title |
| 104 | + |
| 105 | + **Terms** |
| 106 | + |
| 107 | + .. raw:: html |
| 108 | + |
| 109 | + <a class="ansibleOptionLink" href="#parameter-_terms" title="Permalink to this option"></a> |
| 110 | + |
| 111 | + .. rst-class:: ansible-option-type-line |
| 112 | + |
| 113 | + :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` |
| 114 | + |
| 115 | + |
| 116 | + |
| 117 | + |
| 118 | + .. raw:: html |
| 119 | + |
| 120 | + </div> |
| 121 | + |
| 122 | + - .. raw:: html |
| 123 | + |
| 124 | + <div class="ansible-option-cell"> |
| 125 | + |
| 126 | + Something |
| 127 | + |
| 128 | + |
| 129 | + .. raw:: html |
| 130 | + |
| 131 | + </div> |
| 132 | + |
| 133 | + |
| 134 | + |
| 135 | + |
| 136 | + |
| 137 | +.. Options |
| 138 | +
|
| 139 | +
|
| 140 | +.. Attributes |
| 141 | +
|
| 142 | +
|
| 143 | +.. Notes |
| 144 | +
|
| 145 | +
|
| 146 | +.. Seealso |
| 147 | +
|
| 148 | +
|
| 149 | +.. Examples |
| 150 | +
|
| 151 | +Examples |
| 152 | +-------- |
| 153 | + |
| 154 | +.. code-block:: yaml+jinja |
| 155 | + |
| 156 | + |
| 157 | + - name: Look up! |
| 158 | + ansible.builtin.debug: |
| 159 | + msg: "{{ lookup('ns2.col.bar', {}) }}" |
| 160 | + |
| 161 | + |
| 162 | + |
| 163 | + |
| 164 | +.. Facts |
| 165 | +
|
| 166 | +
|
| 167 | +.. Return values |
| 168 | +
|
| 169 | +Return Value |
| 170 | +------------ |
| 171 | + |
| 172 | +.. rst-class:: ansible-option-table |
| 173 | + |
| 174 | +.. list-table:: |
| 175 | + :width: 100% |
| 176 | + :widths: auto |
| 177 | + :header-rows: 1 |
| 178 | + |
| 179 | + * - Key |
| 180 | + - Description |
| 181 | + |
| 182 | + * - .. raw:: html |
| 183 | + |
| 184 | + <div class="ansible-option-cell"> |
| 185 | + <div class="ansibleOptionAnchor" id="return-_raw"></div> |
| 186 | + |
| 187 | + .. _ansible_collections.ns2.col.bar_lookup__return-_raw: |
| 188 | + |
| 189 | + .. rst-class:: ansible-option-title |
| 190 | + |
| 191 | + **Return value** |
| 192 | + |
| 193 | + .. raw:: html |
| 194 | + |
| 195 | + <a class="ansibleOptionLink" href="#return-_raw" title="Permalink to this return value"></a> |
| 196 | + |
| 197 | + .. rst-class:: ansible-option-type-line |
| 198 | + |
| 199 | + :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` |
| 200 | + |
| 201 | + .. raw:: html |
| 202 | + |
| 203 | + </div> |
| 204 | + |
| 205 | + - .. raw:: html |
| 206 | + |
| 207 | + <div class="ansible-option-cell"> |
| 208 | + |
| 209 | + The resulting stuff. |
| 210 | + |
| 211 | + |
| 212 | + .. rst-class:: ansible-option-line |
| 213 | + |
| 214 | + :ansible-option-returned-bold:`Returned:` success |
| 215 | + |
| 216 | + |
| 217 | + .. raw:: html |
| 218 | + |
| 219 | + </div> |
| 220 | + |
| 221 | + |
| 222 | + |
| 223 | +.. Status (Presently only deprecated) |
| 224 | +
|
| 225 | +
|
| 226 | +.. Authors |
| 227 | +
|
| 228 | +Authors |
| 229 | +~~~~~~~ |
| 230 | + |
| 231 | +- Felix Fontein (@felixfontein) |
| 232 | + |
| 233 | + |
| 234 | +.. hint:: |
| 235 | + Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. |
| 236 | + |
| 237 | +.. Extra links |
| 238 | +
|
| 239 | +Collection links |
| 240 | +~~~~~~~~~~~~~~~~ |
| 241 | + |
| 242 | +.. raw:: html |
| 243 | + |
| 244 | + <p class="ansible-links"> |
| 245 | + <a href="https://github.com/ansible-collections/community.general/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> |
| 246 | + <a href="https://github.com/ansible-collections/community.crypto" aria-role="button" target="_blank" rel="noopener external">Homepage</a> |
| 247 | + <a href="https://github.com/ansible-collections/community.internal_test_tools" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> |
| 248 | + <a href="https://github.com/ansible-community/antsibull-docs/issues/new?assignees=&labels=&template=bug_report.md" aria-role="button" target="_blank" rel="noopener external">Submit a bug report</a> |
| 249 | + <a href="./#communication-for-ns2-col" aria-role="button" target="_blank">Communication</a> |
| 250 | + </p> |
| 251 | + |
| 252 | +.. Parsing errors |
| 253 | +
|
0 commit comments