netbox_community.ansible_modules.netbox (0.1.8) — lookup

Queries and returns elements from Netbox

| "added in version" 2.9 of netbox_community.ansible_modules"

Authors: Chris Mills (@cpmills1975)

Install collection

Install with ansible-galaxy collection install netbox_community.ansible_modules:==0.1.8


Add to requirements.yml

  collections:
    - name: netbox_community.ansible_modules
      version: 0.1.8

Description

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

If wanting to obtain the plaintext attribute of a secret, key_file must be provided.


Requirements

Inputs

    
token:
    description:
    - The API token created through Netbox
    required: true

_terms:
    description:
    - The Netbox object type to query
    required: true

key_file:
    description:
    - The location of the private key tied to user account.
    required: false

api_filter:
    description:
    - The api_filter to use.
    required: false

api_endpoint:
    description:
    - The URL to the Netbox instance to query
    required: true

Outputs

_list:
  description:
  - list of composed dictonaries with key and value
  type: list