nb_lookup_lookup.rst

orphan:

netbox.netbox.nb_lookup lookup -- Queries and returns elements from NetBox

Note

This lookup plugin is part of the netbox.netbox collection (version 3.12.0).

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this lookup plugin, see :ref:`Requirements <ansible_collections.netbox.netbox.nb_lookup_lookup_requirements>` for details.

To use it in a playbook, specify: netbox.netbox.nb_lookup.

.. rst-class:: ansible-version-added

New in netbox.netbox 0.1.0

• Synopsis
• Requirements
• Terms
• Parameters
• Examples
• Return Value

Synopsis

• Queries NetBox via its API to return virtually any information capable of being held in NetBox.

Requirements

The below requirements are needed on the local controller node that executes this lookup.

• pynetbox

Terms

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title Terms .. rst-class:: ansible-option-type-line string / required	The NetBox object type to query

Parameters

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title api_endpoint .. rst-class:: ansible-option-type-line string / required	The URL to the NetBox instance to query .. rst-class:: ansible-option-line Configuration: Environment variable: :envvar:`NETBOX\_API` Environment variable: :envvar:`NETBOX\_URL`
.. rst-class:: ansible-option-title api_filter .. rst-class:: ansible-option-type-line string	The api_filter to use. Filters should be key value pairs separated by a space.
.. rst-class:: ansible-option-title key_file .. rst-class:: ansible-option-type-line string	(DEPRECATED) - NetBox 2.11 and earlier only The location of the private key tied to user account. Mutually exclusive with private_key.
.. rst-class:: ansible-option-title plugin .. rst-class:: ansible-option-type-line string	The NetBox plugin to query
.. rst-class:: ansible-option-title private_key .. rst-class:: ansible-option-type-line string	(DEPRECATED) - NetBox 2.11 and earlier only The private key as a string. Mutually exclusive with key_file.
.. rst-class:: ansible-option-title raw_data .. rst-class:: ansible-option-type-line boolean	Whether to return raw API data with the lookup/query or whether to return a key/value dict .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
.. rst-class:: ansible-option-title token .. rst-class:: ansible-option-type-line string	The API token created through NetBox This may not be required depending on the NetBox setup. .. rst-class:: ansible-option-line Configuration: Environment variable: :envvar:`NETBOX\_TOKEN` Environment variable: :envvar:`NETBOX\_API\_TOKEN`
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line string	Whether or not to validate SSL of the NetBox instance .. rst-class:: ansible-option-line Default: :ansible-option-default:`true`

Examples

tasks:
  # query a list of devices
  - name: Obtain list of devices from NetBox
    debug:
      msg: >
        "Device {{ item.value.display_name }} (ID: {{ item.key }}) was
         manufactured by {{ item.value.device_type.manufacturer.name }}"
    loop: "{{ query('netbox.netbox.nb_lookup', 'devices',
                    api_endpoint='http://localhost/',
                    token='<redacted>') }}"

# This example uses an API Filter

tasks:
  # query a list of devices
  - name: Obtain list of devices from NetBox
    debug:
      msg: >
        "Device {{ item.value.display_name }} (ID: {{ item.key }}) was
         manufactured by {{ item.value.device_type.manufacturer.name }}"
    loop: "{{ query('netbox.netbox.nb_lookup', 'devices',
                    api_endpoint='http://localhost/',
                    api_filter='role=management tag=Dell'),
                    token='<redacted>') }}"

Return Value

.. rst-class:: ansible-option-table

Key	Description
.. rst-class:: ansible-option-title Return value .. rst-class:: ansible-option-type-line list / elements=string	list of composed dictionaries with key and value .. rst-class:: ansible-option-line Returned: success

Authors

• Chris Mills (@cpmills1975)

Hint

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.

Collection links

Issue Tracker Repository (Sources)