networktocode.nautobot.lookup (5.1.1) — lookup

Queries and returns elements from Nautobot

| "added in version" 1.0.0 of networktocode.nautobot"

Authors: Chris Mills (@cpmills1975)

Install collection

Install with ansible-galaxy collection install networktocode.nautobot:==5.1.1


Add to requirements.yml

  collections:
    - name: networktocode.nautobot
      version: 5.1.1

Description

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


Requirements

Inputs

    
token:
    description:
    - The API token created through Nautobot
    - This may not be required depending on the Nautobot setup.
    env:
    - name: NAUTOBOT_TOKEN
    required: false

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

plugin:
    description:
    - The Nautobot plugin to query
    required: false

raw_data:
    description:
    - Whether to return raw API data with the lookup/query or whether to return a key/value
      dict
    required: false

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

api_version:
    description:
    - The Nautobot Rest API version to use.
    required: false
    version_added: 4.1.0
    version_added_collection: networktocode.nautobot

api_endpoint:
    description:
    - The URL to the Nautobot instance to query
    env:
    - name: NAUTOBOT_URL
    required: true

validate_certs:
    default: true
    description:
    - Whether or not to validate SSL of the Nautobot instance
    required: false

Outputs

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