Skip to content

Commit 8a2f8b4

Browse files
authored
Add documentation for the option oob_ip_as_primary_ip in nb_inventory plugin (#1218)
Add documentation for the option `oob_ip_as_primary_ip` in nb_inventory plugin
1 parent 594be6d commit 8a2f8b4

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

docs/plugins/nb_inventory_inventory.rst

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1296,7 +1296,7 @@ Parameters
12961296
.. raw:: html
12971297

12981298
</div>
1299-
1299+
13001300
* - .. raw:: html
13011301

13021302
<div class="ansible-option-indent"></div><div class="ansible-option-cell">
@@ -1698,6 +1698,47 @@ Parameters
16981698

16991699
</div>
17001700

1701+
* - .. raw:: html
1702+
1703+
<div class="ansible-option-cell">
1704+
<div class="ansibleOptionAnchor" id="parameter-plurals"></div>
1705+
1706+
.. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-plurals:
1707+
1708+
.. rst-class:: ansible-option-title
1709+
1710+
**oob_ip_as_primary_ip**
1711+
1712+
.. raw:: html
1713+
1714+
<a class="ansibleOptionLink" href="#parameter-plurals" title="Permalink to this option"></a>
1715+
1716+
.. ansible-option-type-line::
1717+
1718+
:ansible-option-type:`boolean`
1719+
1720+
1721+
.. raw:: html
1722+
1723+
</div>
1724+
1725+
- .. raw:: html
1726+
1727+
<div class="ansible-option-cell">
1728+
1729+
If True, `ansible_host` will be set to the out of band ip address if defined, else it will use the `primary_ip`.
1730+
1731+
.. rst-class:: ansible-option-line
1732+
1733+
:ansible-option-choices:`Choices:`
1734+
1735+
- :ansible-option-choices-entry:`false` :ansible-option-choices-default-mark:`← (default)`
1736+
- :ansible-option-choices-entry-default:`true`
1737+
1738+
1739+
.. raw:: html
1740+
1741+
</div>
17011742
* - .. raw:: html
17021743

17031744
<div class="ansible-option-cell">
@@ -2388,7 +2429,7 @@ Examples
23882429

23892430
.. code-block:: yaml+jinja
23902431

2391-
2432+
23922433
# netbox_inventory.yml file in YAML format
23932434
# Example command line: ansible-inventory -v --list -i netbox_inventory.yml
23942435

0 commit comments

Comments
 (0)